Add upgrade instructions

This commit is contained in:
Prathamesh Musale 2024-06-05 12:31:36 +05:30
parent b98018b9f6
commit f989b58f2a
2 changed files with 11 additions and 4 deletions

View File

@ -22,7 +22,7 @@ fi
# Use snapshot if provided
# Take first file with extension .tar.lz4 from the snapshot dir
snapshot_file=$((ls /var/dev/snapshot/*.tar.lz4) 2>/dev/null | head -1)
snapshot_file=$((ls /var/tmp/snapshot/*.tar.lz4) 2>/dev/null | head -1)
geth_dir=${DATA_DIR}/geth
ADDITIONAL_FLAGS=""
if [ ! -d "$geth_dir" ] && [ "${CERC_USE_SNAPSHOT}" = "true" ] && [ -n "$snapshot_file" ]; then

View File

@ -11,7 +11,7 @@ Instructions for running a BSC node
wget -O geth.tar.lz4 https://pub-c0627345c16f47ab858c9469133073a8.r2.dev/geth-pbss-pebble-20240514.tar.lz4
# Example (testnet)
wget -O geth.tar.lz4 https://pub-c0627345c16f47ab858c9469133073a8.r2.dev/testnet-geth-pbss-20240307.tar.lz4
wget -O geth.testnet.tar.lz4 https://pub-c0627345c16f47ab858c9469133073a8.r2.dev/testnet-geth-pbss-20240307.tar.lz4
```
* Clone the stack repo:
@ -46,7 +46,7 @@ Instructions for running a BSC node
```bash
# Example
cp geth-pbss-pebble-20240514.tar.lz4 bsc-node-deployment/data/snapshot/
cp geth.tar.lz4 bsc-node-deployment/data/snapshot/
```
## Configuration
@ -68,7 +68,7 @@ Instructions for running a BSC node
# Fast node does not generate trie data when syncing
CERC_FAST_NODE=
# Garbage collection mode (full | archive) (default: archive)
# Garbage collection mode (full | archive) (default: full)
# Set to archive for archive node
CERC_GETH_GCMODE=
@ -128,3 +128,10 @@ laconic-so deployment --dir bsc-node-deployment up
# Remove deployment directory (deployment will have to be recreated for a re-run)
rm -r bsc-node-deployment
```
## Upgrading
To upgrade the BSC release being used:
* Upgrade the base Docker image used in [Dockerfile](`stack-orchestrator/container-build/cerc-bsc-geth/Dockerfile`)
* Update the release assets URL used for fetching config files in [docker-entrypoint.sh](stack-orchestrator/config/bsc-node/docker-entrypoint.sh)