diff --git a/docs/.vuepress/sidebar.ts b/docs/.vuepress/sidebar.ts index ac62a3324e0..409b208cc6d 100644 --- a/docs/.vuepress/sidebar.ts +++ b/docs/.vuepress/sidebar.ts @@ -639,6 +639,7 @@ export const getSidebar = (locale: string) => `${locale}/subquery_network/node_operators/indexers/introduction.md`, `${locale}/subquery_network/node_operators/indexers/index-project.md`, `${locale}/subquery_network/node_operators/indexers/connect-subgraph.md`, + `${locale}/subquery_network/node_operators/indexers/migrate_existing_deployment.md`, ], }, { diff --git a/docs/subquery_network/node_operators/indexers/migrate-existing-deployment.md b/docs/subquery_network/node_operators/indexers/migrate-existing-deployment.md new file mode 100644 index 00000000000..eeadb81c5a0 --- /dev/null +++ b/docs/subquery_network/node_operators/indexers/migrate-existing-deployment.md @@ -0,0 +1,22 @@ +# Migrate an existing deployment to new version + +## Backgrounds +When author of a project published a version, sometimes you may want to migrate your local deployment to that version to avoid the extra time spending of indexing. +This guide will help you to do that. + +Noted, not all deployments support migration, and for those that do, they only support migrated from specific deployments. +If you tried to migrate from a deployment that does not support migration, the project may fail to start, or you will have the risk of undermining the POI (Proof of Index) of the deployment. + +## Steps +1. Check the deployment instruction that you want to migrate to. Usually the author will provide the details about whether the deployment supports migration and from which deployment it can be migrated. +2. Stop the current deployment from Indexer Admin UI +3. Rename schema in the database to the new schema name. The schema name is the first 15 characters of the deployment id, lower case. e.g `schema_` +``` +# if you runs postgres in docker-compose +sudo docker exec -it indexer_db psql -h localhost -p 5432 -U postgres -d postgres +ALTER SCHEMA RENAME TO ; +``` +4. Add new deployment and start from Indexer Admin UI. +5. Move allocation to the new deployment. +5. Delete old project +