Skip to content

Upgrade from v1.1 to v1.2

This documentation consider that Prelude is installed on two hosts in the /opt/prelude folder. It can be easily adapted for a single host installation.

Backup

Start by a backup of OneBoard database: 

docker compose exec -it db-oneboard pg_dump --dbname=prelude --username=prelude > oneboard.backup.sql

Then, Stop both Prelude OneBoard and Prelude Foundation components. 

docker compose down

Upgrade: Prelude OneBoard

Set the OneBoard container tag to v1.2 in docker-compose.yml. 

image: registry.arolo-solutions.com/<setup-name>/prelude-oneboard:1.2

Pull the new images and start Oneboard : 

docker compose pull
docker compose up -d

Migrate the database: 

docker compose exec -it prelude /app/prelude-oneboard migrate

Connect to PostgreSQL and execute the SQL queries: 

docker compose exec -it db-oneboard psql 'postgres://prelude:password@127.0.0.1:5432/prelude?password=<set password here>'

Queries 

UPDATE prelude_device_interfaces SET interface_speed = interface_type;
UPDATE prelude_device_interfaces SET interface_type = 'plain-interface', usage = 'customer';

Migrate the plugins data: 

docker compose exec -it prelude /app/prelude-oneboard eline migrate_v1_2
docker compose exec -it prelude /app/prelude-oneboard cpe_mgmt migrate_v1_2

Check that all containers are up and running (the name could be slightly different depending on the setup): 

NAME                    IMAGE                                                      COMMAND                  SERVICE       CREATED         STATUS                   PORTS
prelude-oneboard-db-1   postgres:16.1-alpine                                       "docker-entrypoint.s…"   db-oneboard   6 minutes ago   Up 6 minutes             5432/tcp
prelude-nats-1          nats:2.10-linux                                            "/nats-server -c /et…"   nats          6 minutes ago   Up 6 minutes             6222/tcp, 0.0.0.0:4222->4222/tcp, [::]:4222->4222/tcp, 8222/tcp
prelude-oneboard-1      registry.arolo-solutions.com/demo/prelude-oneboard:1.2     "/app/prelude-oneboa…"   prelude       6 minutes ago   Up 6 minutes             0.0.0.0:443->443/tcp, [::]:443->443/tcp, 0.0.0.0:4010->4010/tcp, [::]:4010->4010/tcp

OneBoard upgrade is done.

Upgrade: Prelude Foundation

Start by setting Gateway container tag to v1.2 in docker-compose.yml. 

image: registry.arolo-solutions.com/prelude/prelude-gateway:1.2

Then pull the new images and start Gateway: 

docker compose pull
docker compose up -d

Migrate the database: 

docker compose exec -it gateway /app/prelude-gateway migrate

Add the new package ncs-6.1-prelude-interfaces-utils-1.2.tar.gz to NSO packages: 

cp ~/ncs-6.1-prelude-interfaces-utils-1.2.tar.gz /opt/prelude/volumes/nso/run/packages

Then log in NSO and reload packages: 

docker compose exec -it nso ncs_cli -u admin
> request packages reload

The expected output is: 

admin@ncs> request packages reload

>>> System upgrade is starting.
>>> Sessions in configure mode must exit to operational mode.
>>> No configuration changes can be performed until upgrade has completed.
>>> System upgrade has completed successfully.
reload-result {
    package cisco-iosxr-cli-7.58
    result true
}
reload-result {
    package prelude-core
    result true
}
reload-result {
    package prelude-interfaces-utils
    result true
}
reload-result {
    package prelude-qos
    result true
}
reload-result {
    package prelude-ztp
    result true
}

... for each tailored service ...
reload-result {
    package prelude-<customer>-<service>
    result true
}
... 

[ok][2025-07-09 09:02:15]

Check that all containers are up and running (the name could be slightly different depending on the setup): 

NAME                    IMAGE                                                      COMMAND                  SERVICE       CREATED         STATUS                   PORTS
prelude-gateway-db-1    postgres:16.1-alpine                                       "docker-entrypoint.s…"   db-gateway    6 minutes ago   Up 6 minutes             5432/tcp
prelude-gateway-1       registry.arolo-solutions.com/prelude/prelude-gateway:1.2   "/app/prelude-gatewa…"   gateway       6 minutes ago   Up 6 minutes             0.0.0.0:67->67/udp, [::]:67->67/udp, 0.0.0.0:4020-4021->4020-4021/tcp, [::]:4020-4021->4020-4021/tcp
prelude-nso-1           cisco-nso-prod:6.1.12                                      "/run-nso.sh"            nso           6 minutes ago   Up 6 minutes (healthy)   0.0.0.0:2022->2022/tcp, [::]:2022->2022/tcp

Foundation upgrade is done.