-
Notifications
You must be signed in to change notification settings - Fork 12
docs: add node migration guide for operators #1703
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: netrome <[email protected]>
… field Co-authored-by: netrome <[email protected]>
Co-authored-by: netrome <[email protected]>
netrome
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor changes requested.
…key location Co-authored-by: netrome <[email protected]>
docs/node-migration-guide.md
Outdated
| Install the backup-cli tool using cargo: | ||
|
|
||
| ```bash | ||
| cargo install --path /path/to/mpc/repository/crates/backup-cli |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot can you write this assuming the reader is at the crate root to make this easy to copy-paste? Also add the --locked argument to ensure it's using the right versions of dependencies.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated to use relative path crates/backup-cli (assumes repository root) and added --locked flag. See commit 4c7e81d.
Co-authored-by: netrome <[email protected]>
| ```bash | ||
| backup-cli \ | ||
| --home-dir $BACKUP_HOME_DIR \ | ||
| get-keyshares \ | ||
| --mpc-node-address node.example.com:3000 \ | ||
| --mpc-node-p2p-key "ed25519:YourNodeP2PPublicKey..." \ | ||
| --backup-encryption-key-hex $BACKUP_ENCRYPTION_KEY | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot Before running this we need to get the contract state and write it to the $BACKUP_HOME_DIR/contract_state.json - can you add this to the instructions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a new "Get Contract State" section before the backup step with the command to query and save the contract state to $BACKUP_HOME_DIR/contract_state.json. See commit 893b17d.
Co-authored-by: netrome <[email protected]>
Node Migration Guide - Complete
All Tasks Completed ✅
docs/node-migration-guide.md)Recent Updates (Addressing PR Comments)
Comment 2636513358: Added step to get contract state before backup
near contract call-function as-read-only$BACKUP_HOME_DIR/contract_state.jsonComment 2636490048: Updated cargo install command
/path/to/mpc/repository/crates/backup-clitocrates/backup-cli(assumes repository root)--lockedflag to ensure correct dependency versionsComment 2636460323: Changed installation method to use
cargo installinstead of building from source./target/release/backup-clito justbackup-cliComment 2636462302: Added note about finding encryption key on existing nodes
backup_encryption_key.hexfile in$MPC_HOMEdirectoryDocumentation Created
New File:
docs/node-migration-guide.mdUpdated File:
docs/migration-service-how-to.mdAcceptance Criteria Met ✅
✅ Guide allows node operators to easily migrate a node
✅ Covers all commands needed to perform migration
✅ Accurate JSON structures matching contract interface
✅ Troubleshooting and security considerations included
✅ Integrates with existing documentation structure
✅ Clear explanations of potentially confusing structures
✅ Simplified installation and command usage
✅ Information about encryption key storage location
✅ Easy to copy-paste commands with correct dependency locking
✅ Includes contract state retrieval for backup operations
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.