Upgrading EDA#
Assuming you have a working EDA cluster the upgrade procedure will consist of the following steps:
- Pause NPP interactions.
- Backup your existing cluster.
- Update the playground repository.
- Uninstall the existing version of EDA.
- Install the new EDA
kptpackage (on both active and standby members if running geo redundant). - Restore your backup.
- Upgrade your applications.
- Resume NPP interactions.
Nuances for Air-gapped and Geo-redundant clusters
The upgrade procedure does not change based on whether you have the Internet or Air-gapped cluster. But keep in mind that with the Air-gapped installation the target release bundles should be uploaded to the Assets VM first before proceeding with an upgrade.
In geo redundant clusters, cluster members cannot run different versions. Therefore, before the software upgrade, you must first break cluster redundancy and then restore redundancy after the upgrade. To break the redundancy, remove the .spec.cluster.redundant section from the EngineConfig resource as described later in this document.
EDA upgrade procedure scope
This is the Nokia EDA software upgrade procedure, it does not cover upgrading Talos Linux or Kubernetes. Nokia EDA does not require upgrading Talos or Kubernetes for every EDA version upgrade, unless explicitly stated in the release notes.
In case Talos and/or Kubernetes upgrade is desired perform one of the following:
When running EDA cluster on virtual machines it might be easier to perform a new installation with the desired Talos and Kubernetes versions and restore your existing cluster backup into the new cluster:
- Take a backup of your existing EDA cluster.
- Download an
edaadmversion that comes with the desired Talos and Kubernetes versions as per the version matrix. - Install a new EDA cluster following the installation procedure.
- Restore your backup in the new cluster and upgrade your EDA applications if necessary.
Follow the respective Talos Linux upgrade documentation for upgrading Talos Linux and Kubernetes versions in a running EDA cluster.
Pausing NPP interactions#
Prior to taking a backup of your cluster, place all TopoNode resources into emulate mode to avoid any ongoing interactions with the network devices during the upgrade process.
In this mode, EDA does not interact with target devices, effectively pausing the cluster's interaction with your infrastructure. You can still interact with EDA and the TopoNode resources; changes are pushed upon switching back to normal mode.
To set emulate mode in bulk, run the script from the playground repo directory on a machine where you have kubectl configured with the access to your cluster:
After the script has been run, verify that the TopoNode resources are in emulate mode:
kubectl get toponode -A \
-o custom-columns='NAMESPACE:.metadata.namespace,NAME:.metadata.name,MODE:.spec.npp.mode'
Backing up your cluster#
Backing up your existing cluster is performed using the collect-backup target provided in the Makefile of the playground repository.
This will create a timestamped backup archive in the toolbox pod and copy it to the system where make target was run in the /tmp/eda-support/logs-<date> directory. The backup archive contains all the necessary information to restore your cluster.
Testing the backup
It is highly recommended to test the backup by restoring it in a test cluster before proceeding with the upgrade of your production cluster.
Updating playground repository#
The workflow to upgrade EDA slightly differs depending on whether you have the original playground repository present in a system that you used to install EDA originally from or not.
If you have an existing playground repository, ensure it is up to date by running:
This will update the playground repository while keeping any customizations you may have done to the prefs.mk file.
If the original playground repository is missing, you should clone the repository again:
Identify what EDA version you are running using edactl:
In this example, we have EDA version 25.4.1.
Set the EDA_CORE_VERSION and EDA_APPS_VERSION variables in the prefs.mk file to the existing version you noted above if it is not already set. For example:
Apply any other customizations required to the prefs.mk file as explained on the installation page.
With the existing version set and customizations added to the prefs.mk file, download the EDA packages for the currently running EDA system:
Ensure the package inventory is in sync with your existing cluster:
Uninstalling EDA components#
The existing EDA core components must be uninstalled, before installing the new version.
Breaking geo redundancy (optional)#
If you have a geo-redundant installation, on your active cluster member, update your EngineConfig to remove the .spec.cluster.redundant section. This will break the geo redundancy and allow you to upgrade the active member without affecting the standby member.
Changes on standby members
Do not update the EngineConfig resource on standby members. Although stopped, if the standby members were to start, they must continue to look for the active member (and fail to do so) throughout the upgrade.
Stopping EDA platform#
To stop EDA components, enter the following command:
This command returns no output, but will result in all Pods packaged as part of eda-kpt-base being stopped and removed from the cluster.
Nuances for geo redundant clusters
For geo redundant clusters, execute the edactl platform stop command on both active and standby members, via their respective eda-toolbox Pods.
Uninstalling EDA core components#
Proceed with uninstalling EDA core components:
You should now see no core components in your cluster. Check with the following command1:
Stopping EDA git servers#
Continue with stopping EDA Git servers by scaling down the EDA Git deployments:
Version-specific steps#
When upgrading from versions older than 25.12.1 stop the fluentd daemonset:
Updating EDA kpt packages#
Set the desired EDA version in the prefs.mk file to match the target version you want to upgrade to. For example, to choose the 25.12.1 version:
Download the tools and packages by executing the following command:
Customizing kpt packages#
If you started with a freshly cloned repository, you want to add customizations to your EDA installation by setting the variables in the prefs.mk file; this process is explained in details at the installation phase.
At a minimum, ensure
EXT_DOMAIN_NAMEandEXT_HTTPS_PORTare set correctly in yourprefs.mkfile.
Configure the packages downloaded for the target EDA version with the customizations you added to the prefs.mk file:
Installing the new version of EDA#
Install the new version of EDA core components by running:
Restoring your backup#
Copy the backup file you collected at the beginning of this procedure from your machine back into the new eda-toolbox pod:
backupfile=/tmp/eda-support/logs-2025-12-18/eda-platform-backup-2025-12-18-21-37-42.tar.gz
toolboxpod=$(kubectl -n eda-system get pods \
-l eda.nokia.com/app=eda-toolbox -o jsonpath="{.items[0].metadata.name}")
kubectl -n eda-system cp $backupfile \
$toolboxpod:/tmp/eda-backup.tar.gz
Restore your cluster to its previous state by running:
Upgrading your applications#
Installing the new version of EDA will deploy application versions according to the installed release; however, the backup restore operation will have restored application versions as they were set in the original cluster. These versions may be incompatible with the new version of EDA core, and must be upgraded immediately following the EDA backup restore. The existing Makefile can be used to do so:
Resume NPP interactions#
To resume NPP interactions, set all TopoNode resources back to the normal mode.
After the script has been run, verify that the TopoNode resources are in normal mode:
kubectl get toponode -A \
-o custom-columns='NAMESPACE:.metadata.namespace,NAME:.metadata.name,MODE:.spec.npp.mode'
Verifying cluster health#
Check the following to ensure your cluster is healthy:
- All pods are running and healthy.
- All
TopoNoderesources are innormalmode, and have synced with their targets. - No transaction failures exist.
- All cluster members are synchronized.
-
replace with your base namespace if you modified it. ↩