Skip to content

Docker installer

The following instructions describe how to deploy Prelude with our docker installer.

Note

If you are installing the demo version of Prelude, you won't need the registry account

Before starting, make sure :

Note

For the demo version of Prelude, you can get Cisco NSO trial version from NSO website.

You are ready to start !


The docker installer can be run from anywhere, it will then connect to the Prelude host(s) via SSH.
We are recommending to keep the installer folder secured as it contains security details about your Prelude installation and will be needing to upgrade Prelude later.

The following guide is considering that you are installing Prelude in the /opt/prelude folder on all hosts.

Warning

The installation process have been validated on Ubuntu. We are working on validating other operating systems.

Launch installer

For all the installation options, start one the single host or OneBoard host by launching the installer:

docker run --name prelude-installer --rm \
  -v <installation folder>:/app/workdir \
  -p 8000:8000 \
  -e INSTALLER_IP=<installer host ip> \
  registry.arolo-solutions.com/install/prelude-installer:1.3
  • installation folder a folder that will store the installation details, log, etc. This folder must be different than the one you want to install Prelude into. It will be needed for Prelude upgrades later
  • installer host ip the IP the installer will be available on

If the installer started successfully, you should see:

[2025-08-21 14:52:14 +0000] [1] [INFO] Starting gunicorn 21.2.0
[2025-08-21 14:52:14 +0000] [1] [INFO] Listening at: https://0.0.0.0:8000 (1)
[2025-08-21 14:52:14 +0000] [1] [INFO] Using worker: gthread
[2025-08-21 14:52:14 +0000] [14] [INFO] Booting worker with pid: 14

Then navigate to https://host-ip:8000/ to start the installation

Installation Type

Then, select the installation type and option.

  • Demo/Lab for test purpose if you are not yet a Prelude customer
  • Production if you are already a Prelude customer with tailored services

For the options selection see the dedicated documentation section.

Installer - Install type

Connection Setup

First you need to provide the host(s) details to deploy Prelude on.

Installer - Connection setup

The Host IP address can also be a domain name.

If you choose the installation option 3, you will have to fill the form for each host.

Before moving to the next step, the installer will validate the SSH connection(s).

As the password of each host is not stored persistently but only in memory for maximum 1h. You may encounter the following warning that inform you that you need to re-enter the password(s).

Installer - Password expired

System Requirements

You don't need to do anything specific at the step, just validate that you meat the minimum requirements.

Only the host OS and docker version is blocking the installation, all other checks will raise warnings but won't prevent installing Prelude.

Note

If you selected installation option 3, this step is only checking for OneBoard host requirements

Installer - Requirements

Network configuration

Installation Option 1

Installer - Network option 1

For installation option 1 you need to provide information about OneBoard single interface.

Installer - Network 1: interface

  • IP Address The IP address of the host
  • FQDN The Fully Qualified Domain Name of the host. It must match with the TLS certificate
  • TLS Certificate TLS Certificate for the FQDN
  • TLS Private Key TLS Private Key for the FQDN

Installation Option 2

Installer - Network option 2

For installation option 2 you need to provide information about OneBoard northbound and southbound interface.

Installer - Network 2: northbound

  • IP Address The IP address of the northbound interface of the host
  • FQDN The Fully Qualified Domain Name northbound interface of the host. It must match with the TLS certificate
  • TLS Certificate TLS Certificate for the FQDN
  • TLS Private Key TLS Private Key for the FQDN

Installer - Network 2: southbound

  • IP Address The IP address of the southbound interface of the host

Installation Option 3

Coming soon

Components configuration

If you selected the production installation type, you need to provide your customer namespace. If you don't know it, reach out to your Arolo team.

Installer - Components: oneboard

Then you will have to select Cisco NSO in the Foundation components and upload the linux container image and the NEDs you got from Cisco.

Installer - Components: nso

Docker registry credentials

If you selected the production installation type, you need to provide your registry account. If you don't have tem, reach out to your Arolo team.

Installer - Registry

Configuration review

Finally, review the config parameters and start the installation.

Installer - Review

After a while, the installation will be done.

Installer - Install done

Success

Congratulations, you are now ready to enjoy Prelude features !!