Upgrading Pryzm Node with Docker Compose

This documentation provides a step-by-step guide on how to upgrade your Pryzm node with minimal downtime when running with Docker and Docker Compose. By following this approach, you can reduce the amount of time your Pryzm node is offline during the upgrade process.

Prerequisites

Before proceeding with the upgrade, make sure you have the following:

• A running Pryzm node managed with Docker Compose.
• Basic knowledge of Docker and Docker Compose.
• Access to the internet to download the latest version of Pryzm.

Upgrade Process with Minimal Downtime

1. Visit the official Pryzm repository or release page to download the latest version of Pryzm compatible with Docker.

2. Once you have downloaded the new Pryzm version, replace the existing Pryzm binary file in your Docker environment. Locate the Pryzm binary file within your Docker Compose setup (often defined within the Dockerfile or docker-compose.yml).

3. Update the version number in your docker-compose.yml file. Locate the image field under the Pryzm service and update the version tag to match the newly downloaded version. For example:

   services:
     pryzm:
       image: europe-docker.pkg.dev/pryzm-zone/core/pryzmd:<new_version_tag>
       # ...

4. Save the changes to the docker-compose.yml file.

5. Run the following command to initiate the upgrade process while minimizing downtime:

   docker-compose pull pryzm && docker-compose up -d pryzm

   This command performs the following actions:

   • Pulls the updated Pryzm image from the Docker registry.
   • Starts the new Pryzm container using the updated image.
   • Minimizes downtime by only updating the Pryzm container and leaving the other containers intact.

6. Monitor the logs of the upgraded Pryzm node container to ensure a successful startup. Use the following command to view the container logs:

   docker-compose logs -f pryzm

   Watch for any error messages or unexpected behavior during the startup process. If you encounter any issues, refer to the Pryzm documentation or community resources for troubleshooting assistance.

7. Verify that the upgrade was successful by checking the logs and ensuring the Pryzm node is operating as expected.

8. Once you confirm the upgraded Pryzm node is running smoothly, you can check the status of your node by executing the following command:

   docker compose exec pryzm pryzmd status

   This command checks for the status of your node ensuring you are syncing blocks after upgrade.

Congratulations! You have successfully upgraded your Pryzm node running with Docker Compose, minimizing the downtime during the upgrade process. Ensure to stay updated with the Pryzm network's documentation and community resources for any future updates or announcements related to upgrades and maintenance.