In-place Upgrades
3.1 Introduction
In contrast with a parallel upgrade (Chapter 2), with an in-place upgrade the production cluster is taken out of operation while the upgrade takes place.
This chapter covers the procedure for an in-place upgrade.
3.2 Existing Cluster Health Check
It is a good idea to check that the existing cluster is in a healthy state before carrying out the upgrade.
The head nodes health checks in particular should be looked at. Unexpected health check failures should be examined, and if required, resolved. In some cases it is expected that health checks will be in a failed state. For example, if all the compute nodes are DOWN, then the schedulers health check fails.
The reason behind checking the health of the cluster before upgrading is that the health checks can detect failing services, overfull filesystems, unmounted filesystems, networking issues, time synchronization issues, and other issues. If these are unexpected then they can prevent the upgrade from completing successfully.
3.3 Important: Upgrading Particular Applications
3.3.1 Overview Of The Applications That cm-upgrade Does And Does Not Manage
3.3.1.1 Automatically Upgraded By cm-upgrade
The following software, if managed by BCM 10, is managed and upgraded automatically by cm-upgrade to BCM 11:
-
Docker
-
The
cm-docker-registrypackage (Harbor upgrades(section 3.3.6)
are not supported)
-
Jupyter
(the JupyterHub database requires some additional care (section 3.3.5)).
-
Base View: The regular version of Base View in BCM 10 is upgraded to a new version in BCM 11. Any monitoring dashboards from the regular BCM 10 Base View version are no longer used in the BCM 11 Base View version
(section 3.3.2).
-
NVIDIA drivers: The defaults will be installed in non-DGX images
3.3.1.2 Automatically Kept As Is By cm-upgrade
The following applications are allowed to remain during the upgrade, and are not automaticaly upgraded:
-
WLMs
(section 3.3.3)
-
Slurm
-
LSF
The installation of workload managers is described in section 7.3 of the Administrator Manual, while the upgrade of the Slurm workload manager is described in section 7.5 of the Administrator Manual.
-
-
Kubernetes: Kubernetes installation is described in section 4.22 of the Containerization Manual.
-
Run:Ai: Run:Ai installation options for BCM are described in section 6.11 of the Containerization Manual.
-
NVIDIA Container Toolkit: An NVIDIA Container Toolkit installation can be carried out as part of Docker setup or a package installation (section 2.7 of the Containerization Manual).
-
other Kubernetes operators: The installation of other Kubernetes operators is described in Chapter 6 of the Containerization Manual.
3.3.1.3 Manually Removed And Reinstalled During Upgrade (Not Managed By cm-upgrade)
-
Harbor: As explained earlier, Harbor upgrades
(section 3.3.6)
are not supported. The Harbor package needs to be removed from BCM version 10, and redeployed (section 3.2 of the Containerization Manual) in BCM version 11.
-
Cluster Extension: Needs to be removed and redeployed (Chapter 3 of the Cloudbursting Manual)
3.3.1.4 Removed From Support During Upgrade (Not Managed By cm-upgrade)
The following software is no longer managed by BCM in BCM version 11.
-
(Altair) Grid Engine (AGE): BCM support for integration ended. Possible alternatives to the AGE WLM, that BCM supports, are Slurm and LSF.
-
PBS Professional and OpenPBS: BCM support for integration ended. Possible alternatives, that BCM supports, are Slurm and LSF.
-
Apptainer/Singularity: the
cm-apptainerpackage is no longer built or provided. The upstream Apptainer packages can be used instead. -
cmjob: BCM support ended. -
Machine learning packages (RPMs and DEBs): no longer provided.
-
GigaIO: BCM support for integration ended.
-
Direct attached storage for HA setups: no longer supported.
-
OpenShift: BCM support for integration ended.
3.3.2 Upgrading Base View
BCM has Base View (section 2.4 of the Administrator Manual) as the browser GUI to carry out cluster management tasks. It is available as the package base-view.
Base View in BCM 10 had an additional, experimental and undocumented, Base View NG, available as the package base-view-ng. Base View NG uses a newer GUI toolkit from that of Base View in BCM 10.
Base View in BCM 11 is actually just a development of Base View NG from BCM 10, and so it uses that newer toolkit too.
The new Base View in BCM 11 means that an upgrade from BCM 10 to BCM 11 loses all the dashboards that users and administrators may have built for Base View in BCM 10.
It is therefore a good idea to make notes on the useful dashboards of BCM 10 so that analogous ones can be constructed for BCM 11. A useful transition may be to construct the analogues in Base View NG while still on BCM 10, before upgrading to BCM 11.
3.3.3 Upgrading Workload Managers (WLM)
Unsupported unversioned or unsupported versioned WLM packages are not removed automatically. They must be removed manually. If they are to be updated then it is recommended to install new, supported, versioned WLM packages.
The supported PBSPro versions are compatible across BCM 10 and BCM 11.
3.3.3.1 Upgrading WLMs In General From BCM 10
WLMs are not required to be disabled using cm-wlm-setup before upgrading the BCM version from 10 to 11.
3.3.3.2 Upgrading Slurm
Slurm versions older than Slurm 24.11 are not supported in BCM 11. When upgrading from BCM 10, Slurm must be upgraded to at least Slurm 24.11 in the BCM 10 repositories before moving to BCM 11.
Upgrading Slurm on a BCM 10 cluster is described in section 7.5 of the BCM 10 Administration Manual.
Packages:
Software images now include the same packages as the head nodes. This is because starting with BCM 11, Slurm packages keep many things in /cm/local, instead of /cm/shared.
Slurm client packages, for example slurm25.05-client, are no longer available. So they are removed as part of the upgrade procedure.
There are now separate slurmctld and slurmd packages that provide the binary and systemd unit files for each service.
Path adjustments: There are some path adjustments for Slurm for the upgrade from BCM 10 to BCM 11, as summarized in the following table.
3.3.3.3 Slurm DBD Performance Improvement
Installations from BCM 10.24.05 onward have MySQL configuration settings changes that improve the performance of the slurmdbd service. The changes are not automatically applied during updates of MySQL when updating from versions installed earlier than BCM 10.24.05.
To apply the improvement to a cluster that does not have this update, the MySQL configuration must be manually adjusted on the head nodes after cm-upgrade has completed. The /etc/my.cnf file on the head node, and also on the secondary head node in an HA-enabled cluster, should have the following settings updated:
The default my.cnf file is typically symlinked by the system utility update-alternatives in Ubuntu and SLES, (alternatives in RHEL derivatives), so how it is configured should also be considered.
3.3.3.4 Slurm Upgrades For DGX OS 6 To DGX OS 7
For DGX, BCM 10 supports only DGX OS 6 (an Ubuntu 22.04 variant), while BCM 11 supports DGX OS 7 (an Ubuntu 24.04 variant). Since BCM point release 11.34.0, BCM also supports DGX OS 8 (an Ubuntu 26.04 variant) for x86_64.
As part of the upgrade from BCM 10 to BCM 11, the DGX OS must be replaced with DGX OS 7. When replacing the DGX OS nodes from 6 to 7, a new software image (and /cm/shared) is created for the Ubuntu 2404 nodes.
If Slurm and Pyxis have been deployed in a BCM 10 DGX OS 6 image, then some manual configuration changes must be done to make these work right in the BCM 11 DGX OS 7 image. These can be carried out as follows:
Changes to the MUNGE key in /cm/shared: The key needs to have the correct permissions and ownership. If it does not have these, then a symptom of it is the message:
as seen in the systemd status output:
The key can be made consistent with that of the previous deployment. This can be done by changing the attributes of the files in the new DGX software image, for example dgx-os-7.2-h100-image, after mounting it in the appropriate shared directory on the new cluster:
Example
Changes to the Pyxis and Enroot files: The files within the DGX OS 7 image can be configured as follows:
Copy the Pyxis plugin file to the new software image, for example: dgx-os-7.2-h100-image:
Example
Copy the plugstack files in /cm/shared over from the Ubuntu 2204 (DGX OS 6) version to the Ubuntu 2404 (DGX OS 7) version:
Example
Copy the Enroot configurations in /cm/shared from the Ubuntu 2204 version to the Ubuntu 2404 version:
Example
Symlinks for the epilog, prolog, and enroot.conf files are created for the new software image:
Example
The compute nodes can pick up the new configuration when they get rebooted.
3.3.4 Upgrading The Kubernetes Package
Kubernetes deployments do not need removal before upgrading to BCM 11. The same version of Kubernetes runs on the BCM cluster after the upgrade.
An upgrade to Kubernetes (section 4.22 of the Containerization Manual) can be carried out after the BCM upgrade.
3.3.4.1 Kubernetes Package Upgrades For DGX Software Images
When upgrading DGX OS nodes from 6 to 7.2, a new software image (and /cm/shared) needs to be created
(section 3.8.13),
for the nodes which will be running Ubuntu 24.04.
Kubernetes on the new DGX image needs to be manually copied over from the old image. This can be done as follows:
-
The
kubernetes.listfile should be copied over from the old image, <old DGX image>, to the new image, <new DGX image>, along with its associated keyring file:Example
-
The packages for the existing version need to be placed in the new image (here it is called
new-dgx-image): -
The packages for the existing version need to be held. The following commands take care of that:
The is to exit out of the cm-chroot-sw-img directory. The cm-chroot-sw-img command is described here.
3.3.5 Upgrading The JupyterHub Database
The JupyterHub database schema must be manually upgraded in each JupyterHub node after the main package upgrade has completed. The following commands can be run to upgrade the JupyterHub database:
3.3.6 Upgrading The Docker Registry And Harbor Packages
Harbor cannot be upgraded when BCM 10 is upgraded to BCM 11, its package can only be (re-)installed and (re-)deployed separately from the BCM upgrade.
If the Harbor packages were installed in BCM 10 to a node other than the head node, then a re-deployment to that node is required after the upgrade to BCM 11 for Harbor.
When upgrading a cluster from BCM 10 to BCM 11 the upgrade of Docker registry is supported.
3.4 Important: Package Upgrade Dependency Issues
The upgrade process will not only upgrade CMDaemon and its dependencies, but it will also upgrade other packages. This means that old packages will not be available from the new BCM repositories.
In some cases, this will require recompiling the user applications to use the upgraded versions of the compilers and the libraries. Also, the configurations of the old packages will not be copied automatically to the new packages, which means that the administrator will have to adjust the configuration from the old packages to suit the new packages manually.
Extra base distribution packages may be installed by yum/zypper/apt-get in order to resolve dependencies that might arise as a result of the upgrade. Hence the base distribution repositories must be reachable. This means that the clusters that run the Enterprise Linux distributions (RHEL and SLES) must be subscribed to the appropriate software channels.
Packages in /cm/shared are upgraded, but the administrator should be aware of the following:
-
If
/cm/sharedis installed in the local partition, then the packages are upgraded. This may not be desirable for users that wish to retain the old behavior. -
If
/cm/sharedis mounted from a separate partition, then unmounting it will prevent upgrades to the mounted partition, but will allow new packages to be installed in/cm/sharedwithin the local partition. This may be desirable for the administrator, who can later copy over updates from the local/cm/sharedto the remote/cm/sharedmanually according to site-specific requirements. Since unmounting of mounted/cm/sharedis carried out by default, a local/cm/sharedwill have files from any packages installed there upgraded. According to the yum database, the system is then upgraded even though the files are misplaced in the local partition. However, the newer packages can only be expected to work properly if their associated files are copied over from the local partition to the remote partition.
3.5 Known Issues
3.5.1 Kubernetes PVC Access Issue With The Shared Directory For Multidistro (MultiOS)
With a multidistro Kubernetes cluster, there can be a known issue with accessing /cm/shared across the various nodes.
3.5.1.1 Under What Conditions Is There An Issue?
The issue can occur when all of the following conditions apply:
-
The Kubernetes cluster (and worker nodes in particular) are spread across multiple DGX OS versions, due to one of the following situations:
-
(A) the nodes are running as multidistro nodes within the same Kubernetes cluster (running permanently as multidistro as is the intention, and not just transiently as part of an upgrade).
-
(B) the nodes are being upgraded, for example from Ubuntu 22 to Ubuntu 24
-
-
The Local Path Provisioner is provisioned and deployed in the Kubernetes cluster. This is a component running in Kubernetes that enables pods in every Kubernetes node to consume some kind of local storage. The
local-path-provisionerparameter provides the local pathStorageClass, which sets up a sub-directory under/cm/shared. -
In this Kubernetes cluster, there is at least one pod using the local-path StorageClass using a PVC (PersistentVolumeClaim)
3.5.1.2 Why Is There An Issue?
The problem is that the /cm/shared directory is not unique across all nodes in a BCM cluster. The directory differs based on the DGX OS version. For example, on the head node, for the /cm/shared mount, you have:
-
for Ubuntu 22 nodes:
/cm/shared-ubuntu2204-x86_64 -
for Ubuntu 24 nodes:
/cm/shared-ubuntu2404-x86_64
During normal running, each DGX node only sees its specific /cm/shared.
Now, if a pod consuming a PVC from its local-path StorageClass is rescheduled to a node from the other DGX OS, then it cannot find the volume anymore, and it creates a new one.
3.5.1.3 Resolving The Issue For Persistent Mixed Distributions
A solution in the case of persistent mixed distributions on the nodes is to move all the pods to a new common shared directory for Kubernetes, independent of the directories offered for the specific DGX OS versions.
Steps:
-
If the cluster is not HA, then
-
a new
/cm/shared-kubedirectory can be created -
a new fsexport is created on the headnode:
Example
-
-
If the cluster is HA, then
-
a new directory or export can be created in the NAS to store the Kubernetes directory
-
if the headnode is a Kubernetes workers, or if the head node is a Kubernetes control-plane node that uses volumes using pods, then volumes will be used. Create an fsmount on the head nodes with:
Example
-
-
Create an fsmount in the Kubernetes worker nodes categories (and/or nodes):
Example
-
Turn off all the Kubernetes worker nodes using
cmshThis ensures that all pods are down, and not writing to the PVCs
-
On the head node, populate the whole directory with all the data from Kubernetes:
Example
-
If present, copy specific PVCs from Ubuntu 24.04 as well:
Example
-
Turn on all the Kubernetes worker nodes
-
Ensure the Kubernetes worker nodes mount the new
/cm/shared/apps/kubernetesdirectoryExample
-
Ensure all the pods are up and running again:
Example
-
Afterwards, clean up the old PVCs:
Example
3.5.1.4 Resolving The Issue For The Upgrade Case Only
A solution in the case of an image upgrade, for example from DGX OS 6 to DGX OS 7, can be carried out as follows:
Before starting the upgrade of DGX OS version, you can move all PVCs from the old to the new /cm/shared.
We assume old nodes are running Ubuntu 22 and that they need to be upgraded to Ubuntu 24.
-
Turn off all the (Ubuntu 22.04) Kubernetes worker nodes via
cmshThis ensures that all pods are down and not writing to the PVCs.
-
Upgrade DGX OS to Ubuntu 24.04
-
On the head node, copy all the PVCs to the other new
/cm/sharedExample
-
Turn on all the Kubernetes worker nodes and check that all the pods are up and running again (
kubectl get pods -A) -
Afterwards, clean up the old PVCs:
Example
3.5.1.5 Resolving The Issue If You Already Have Duplicated PVCs
A solution in the case of PVCs that have already been duplicated requires some finesse.
-
Detect all PVCs in the old and new
/cm/sharedand mapping between them. First look for current PVCs and ensure each one has the related directory in the new shared directory:-
kubectl get pvc -A -
ls /cm/shared-ubuntu2404-x86_64/apps/kubernetes/default/var/volumes/
-
-
Turn off the nodes
-
Backup or move the newly created PVCs, that most likely should be deleted:
Example
-
Now, for each PVC, you have to find the original/correct one in the former shared directory. This is a manual process, and a bit of an art. You can consider:
-
The directory name which matches the Kubernetes namespace and PVC name
-
If there are 2 or more matching directories then:
-
look for the latest modification date (
ls -lah) -
check the overall size (
du -hs). Usually the largest directory has more data and should be the most recent one
-
-
-
Run an
rsynccommand per PVC:Example
Note: the source and target directories are different (
...-ubuntu2204-...to...-ubuntu2404-...). This is because the source should match what you have found out in the previous step, while the target should match what you listed initially. -
Turn on nodes and verify pods are up and running
3.5.2 Miscellaneous Known Issues
-
On clusters with Jupyter deployed, after the upgrade, users might find themselves being asked to login twice. The first time when the user will be asked to login to JupyterHub, and a second time, where the user is asked about a “CMDaemon login”. In such cases, the user should once again present the credentials. This extra login request is harmless, and after the credentials are given a second time, it is unlikely that users will be queried again. The cause of this issue is that the Jupyterhub component that interacts with CMDaemon can lose connection to CMDaemon, causing it to prompt for an extra login.
-
On some base distributions, depending on the version of the installed packages, when starting
cm-upgrade, a YAMLLoadWarning message may be printed when its configuration files are loaded. The warning message can be safely ignored. -
In some cases because
/cm/sharedmay be temporarily not accessible from the cloned primary head node when it boots for the first time, if workload managers are setup on the cluster, then CMDaemon may create and leave module files calledno-version. For example:
slurm/slurm/no-version
To resolve the issue, the leftoverno-versionmodule files under/cm/shared/modulefiles/can be deleted. -
In some cases at the end of the head node or the software image(s) upgrade, the
cm-upgradescript may report a list of packages that were not upgraded to their BCM 11 versions. This can occur in cases where the package manager was not able to resolve the list of packages to find a suitable candidate at the time of the upgrade of all packages.While
cm-upgrademakes a best effort to swap or upgrade the packages to their BCM 11 versions, in some cases— notably on Ubuntu, it is also possible some packages are left in their 10.0 versions.The administrator is advised to manually swap the
cm10.0packages with thecm11.0package. -
On clusters with cluster extension to AWS deployed, the cloud director and cloud nodes might fail to start after the upgrade. This can happen when there is an entry
in the disksetup. The issue can be resolved by removing that entry from the disksetup for the cloud director and cloud nodes.
-
On clusters that have PBSPro configured, and upgraded from BCM 10 to BCM 11, new jobs submitted by users will get job ids that were already used. This is particularly relevant for users that use BCM monitoring data for billing purposes.
-
Disabling Kubernetes as part of the parallel-upgrade procedure results in an apparent failure during the stage when etcd data is cleaned up, because the compute nodes are not reachable from the parallel setup. This is expected since the parallel setup is isolated from the production setup. To resolve the issue, the administrator should answer a prompt so that the failed stage is skipped. It is also recommended to re-provision the compute nodes of the upgraded parallel setup before attempting to set up Kubernetes or etcd again, so that any leftover data from before the upgrade is cleaned during the provisioning.
-
When upgrading the DGX OS 6 sofware image to the latest updates of DGX OS 6, there is a known issue with DKMS when a new kernel
linux-image-5.15.0-1090-nvidiais installed. The DKMS post-install script fails for the new kernel. This is caused by duplicate entries for thegdrdrvmodule. This can be checked for with the following command:The last two statuses are for the same driver, and the last line is
builtrather thaninstalled, which means it was not installed, and leads to the post-install script failure.This issue can be resolved by removing the duplicate entry and reconfiguring the package as follows:
-
When checking if the compute nodes are UP, in some cases
cm-upgrademay wrongly report that some nodes are not DOWN. The report depends on how a node has been shut down, the state of the node not being updated correctly in the CMDaemon database. In such scenarios, after confirming that the nodes are indeed DOWN, re-runcm-upgradewith the--skip-node-states-checkflag to skip the check for node states:Example
-
Upgrading from BCM 10 to BCM 11 for DGX SuperPOD deployments requires filesystem exports to be explicitly set for the network
dgxnet(here). -
The BCM machine learning repositories may still be referenced in the repository lists. They should be removed. For example, in the Ubuntu head node and images with:
3.6 Upgrading Using A BCM DVD/ISO
When using a BCM DVD/ISO to perform the upgrade, it is important to use a DVD/ISO that is not older than 11.30.0. The DVD/ISO version can be found (assuming that the DVD/ISO is mounted under /mnt/cdrom) with a find command such as:
3.7 Enable Upgrade
3.7.1 Enable The Upgrade Repo, And Install The Upgrade Package
Enabling the upgrade repository and installing the upgrade package can be carried out for the various distributions as follows:
RHEL8 derivatives:
RHEL9 derivatives:
SLES 15:
Ubuntu 22.04:
Ubuntu 24.04:
3.7.2 Load The Environment Module
3.8 Perform Upgrade
The steps for carrying out the upgrade are as follows:
3.8.1 Power Off Nodes
-
Power off regular nodes
-
Terminate cloud nodes and cloud directors, and remove the cloud extension(s)
3.8.2 Apply Updates To Head Node
-
RHEL derivatives:
-
SLES derivatives:
-
Ubuntu:
3.8.3 Apply Updates To Software Images
Before updating and upgrading a software image, it may be worth creating an image backup by cloning the image (here). If the cluster after the upgrade has an image that has an issue, then comparing it against the backup can help troubleshoot the issue.
For each software image, updates can be applied as follows:
-
RHEL derivatives:
-
SLES derivatives:
-
Ubuntu:
3.8.4 Apply Updates To The node-installer Image
-
RHEL derivatives:
-
SLES derivatives:
-
Ubuntu:
3.8.5 Upgrade Head Nodes To BCM 11
Important: this must be run on both head nodes in a high availability setup. Recommended: Upgrade the active head node first and then the passive head node.
Depending on availability, the upgrade can be run either over the network, or using a DVD/ISO:
-
Upgrade using repositories accessible over the network
-
Upgrade using a BCM DVD/ISO
In an HA setup, after upgrading both the head nodes, resync the databases. Run the following from the active head node (it is very important to complete this step before moving to the next one):
3.8.6 Reboot Head Node(s)
The head node(s) must be rebooted before proceeding to run the post-upgrade actions.
3.8.7 Post-upgrade Head Node Actions
Important: these must be run on both head nodes in an HA setup
3.8.8 Upgrade The Software Image(s) To BCM 11
Important: the upgrade to the software images must be done only on the active head node. Depending on availability, the upgrade can be run either over the network, or using a DVD/ISO:
-
Upgrade using repositories accessible over the network
-
Upgrade using a BCM DVD/ISO
If the software images are not under the standard location—/cm/images/ on the head node—then the option -a should be used:
If the software images are located under multiple locations, the target locations can be specified as a comma-separated list:
3.8.8.1 Btrfs Image Upgrades
If the software image is a Btrfs image, then the revision (section 14.4 of the Administrator Manual) images cannot be used, because they use read-only filesystems. This issue extends to all references in category or node images, such as @latest and @number
Only the original, unrevisioned, parent image can be upgraded with the cm-upgrade and cm-post-upgrade steps with a Btrfs filesystem.
A workaround would be to create a new non-CoW image from a trusted revision, and upgrading that trusted non-CoW version.
3.8.9 Upgrade /cm/node-installer To BCM 11
This needs to be performed only on the primary active head node, either over the network, or using a BCM DVD/ISO.
-
Upgrade using repositories accessible over the network:
-
Upgrade using a BCM DVD/ISO:
3.8.10 Post-upgrade Software Images Actions
Important: these must be run only on the active head node.
If the software images are not under the standard location, which is /cm/images/ on the head node, then the option -a should be used:
If the software images are located under multiple locations, then the target locations can be specified as a comma-separated list:
3.8.11 NVIDIA Driver Installation
During the upgrade to BCM 11.0, cm-upgrade automatically installs NVIDIA GPU drivers on non-DGX software images. This is only carried out on software images. It is not carried out on the head nodes or the node-installer images.
3.8.11.1 Default NVIDIA Driver Version
By default, cm-upgrade installs NVIDIA driver version 570 (Open Kernel Modules edition). The following components are installed:
-
On Ubuntu 22.04 and 24.04: the package installed is the
nvidia-driver-570-openmeta-package plus additional components including:-
Fabric Manager (for NVLink/NVSwitch management)
-
NSCQ library (NVIDIA NVSwitch Configuration and Query Library)
-
IMEX library (GPU memory sharing across different compute nodes in a multi-node system connected by NVLink)
-
NVSDM library (for monitoring NVSwitch devices on NVIDIA Blackwell systems)
-
-
On RHEL 9/Rocky 9: a comprehensive set of packages based on the major 570 version. The package set installed includes:
-
DKMS and open kernel modules for dynamic kernel support
-
Core driver libraries and CUDA components
-
Fabric Manager for multi-GPU interconnect management
-
GUI tools (nvidia-settings, nvidia-xconfig) for X11 display configuration
Most package names are generic (for example: nvidia-driver, nvidia-fabric-manager), with the exact version version determined by the repository configuration
-
-
On SLES 15 SP6: the package installed is a set based on the major 570 version, and includes:
-
Open kernel modules (
nvidia-open-570) -
Fabric Manager and NSCQ library
Packages are sourced from NVIDIA’s CUDA repository (version-numbered). Native SLES packages use G06 generation naming, but we use NVIDIA’s CUDA repository for consistency
-
3.8.11.2 Non-DGX Systems Only
NVIDIA driver installation is only carried out on non-DGX systems.
DGX systems have pre-installed NVIDIA drivers, which are maintained by NVIDIA’s own update mechanisms, and should not managed by cm-upgrade. The upgrade script detects DGX systems by checking for the presence of /etc/dgx-release in the software image. If this file exists, then NVIDIA driver installation in the DGX system is skipped.
3.8.11.3 Changing the NVIDIA Driver Version
If you need to install a different version of the NVIDIA drivers, then you can modify the driver version either before or after the upgrade as follows:
-
Pre-upgrade: Edit
/cm/local/apps/cm-upgrade/11.0/conf/packages.yamland modify the package versions listed under thenvidia_driver_packagessection for your distribution. -
Post-upgrade: Use the standard package management tools (
yum/apt/zypper) within the software image to remove the installed driver packages and install your preferred version.
3.8.12 (HA) Allow For The Provisioning Requests To The Secondary Head Node To Complete
Allow between 15 and 30 seconds for CMDaemon to schedule and start provisioning updates of /tftpboot and /cm/node-installer from the primary to the secondary head node. Then check and wait until the provisioning requests with the secondary head node as destination have completed using:
If the provisioning requests with a destination node the secondary head node continue to be listed for a prolonged period of time and do not disappear from the list, then the node-installer and/or tftpboot on the secondary head node are out of sync from the primary head node, which can result in issues with provisioning of the compute nodes. Please contact support (https://enterprise-support.nvidia.com/s/create-case) for further assistance.
3.8.13 Enable Mixed OS Setup And Create A DGX OS 7 Image
On BCM 10 Ubuntu 22.04 clusters can use DGX OS 6 images. DGX OS 6 images are not supported in BCM 11.
A new DGX OS 7 software image must therefore be used. The image can be created using cm-image and cm-create-image. These are BCM utilities, and are described in section 9.6 of the Administrator Manual.
DGX OS 7 is based on Ubuntu 24.04. This then also means the mixed OS environment—multidistro or multiOS as described in section 9.7 of the Administrator Manual—must be enabled, to allow provisioning of DGX OS 7 images from the Ubuntu 22.04 head node of BCM 10.
Image creation can be carried out as follows:
-
A script may need to be created first:
Example
The script is only needed for a cluster running a BCM version 11 earlier than 11.31.0. It works around a known issue that may arise from using an upstream repository in an inappropriate manner. For BCM 11.31.0 and later, the workaround is carried out automatically, and the script is not needed.
-
Use
cm-imageto create the appropriate the Ubuntu 24.04 base images and enable a mixed OS setup. The-zoption that calls the script need only be used for BCM 11 installations earlier than BCM 11.31.0.Example
-
Use
cm-create-imageto create the new DGX OS image. The-zoption that calls the script need only be used for BCM 11 installations earlier than BCM 11.31.0.
The --dgx-type option (here) must be set for every type that is to be used as an image. The possible values are:
-
dgx_h100for the H100 GPU -
dgx_b200for the B200 GPU -
dgx_a100for the A100 GPU -
dgx_gb200for the GB200 GPU -
dgx_h200for the H200 GPU -
dgx_gb300for the GB300 GPU -
dgx_b300for the B300 GPU
The cluster administrator should create a new category for each new image. Cloning the default-image image from the default category is a convenient way to do this since it already has the correct fsmounts. The image name should then be set for the category.
For example, for a B200 image dbx-os-image-b200 that has been placed in /cm-images/:
Example
The nodes that are to use the new image should then be assigned their image. For example, a node001 can be assigned to the gb200 category created in the preceding example with:
Example
Configuration overlays that were used in the old category should also be migrated as needed to the new category.
Upgrading from BCM 10 to BCM 11 for DGX SuperPOD deployments requires NFS exports to be explicitly set for the network dgxnet, for /cm/node-installer-ubuntu2404-x86_64 and /cm/node-installer-ubuntu2404-x86_64/certificates.
This can be configured with the following cmsh session on the head node:
Example
The same procedure must also be carried out for that secondary head node.
The new DGX OS image has no Kubernetes packages installed on it by default. Migrating an old Kubernetes installation over from the old image is described here.
3.8.14 Upgrading CMDaemon Lite
The BCM 10 to BCM 11 upgrade supports CMDaemon Lite (section 2.6.7 of the Administrator Manual) running on cluster switches, such as Cumulus switches.
After the upgrade has been carried out on the head node and the images are ready for deployment, then the switches can be rebooted to pick up their new image.
- It is important not to reboot the switch that is being used to connect to the head node.
After the switches have rebooted, the compute nodes can be powered on.
In a cluster, mixing deployments of cm-lite-daemon for BCM 10 with those of BCM 11 is not supported.
This means that the CMDaemon Lite servers that are not managed by CMDaemon, for example PCs running CMDaemon Lite in a Python environment, also need to be upgraded when upgrading the cluster itself from BCM 10 to BCM 11. That must be done manually, by removing the BCM 10 package, and installing the BCM 11 package according to the environment and OS it is running in.
3.8.15 The Cluster Is Now Upgraded To BCM 11
It is recommended to provision the compute nodes at least once with BCM 11 before setting up any new integrations.
3.9 Simple Validation Checks
Some basic checks can be carried out to validate the cluster. If a check fails, then further investigation should be carried out.
3.9.1 Validating CMDaemon
The CMDaemon service status (section 2.6.1 of the Administrator Manual), can be checked with:
Example
3.9.2 Validating High Availability
If the cluster has HA configured, then the cluster manager HA status (here), can be checked. For example, for head nodes basecm11-a and basecm11-b the response to the check would be:
Example
3.9.3 Validating cmsh And Devices
A check on the device statuses can be run with:
Example
3.9.4 Validating The Cluster Health
Health check values can be retrieved from devices in the BCM monitoring system with the help of the latesthealthdata command (section 10.6.3.1 of the Administrator Manual):
Example
3.9.5 Validating Base View
For a dotted quad IP address <IP address>, the cluster administrator can connect to:
https://<IP address>:8081/base-view
and try logging in. If there was non-administrator access before the upgrade, then that should also be checked.
3.9.6 Validating The State Of The Packages On The Cluster
The state of packages according to the package manager for the cluster can be checked in the head nodes and in the software images with:
3.9.6.1 Ubuntu Packages
3.9.6.2 RHEL-like Distribution Packages
3.9.6.3 SLES Packages
These commands should all normally give no output, other than processing messages in some cases.
3.9.7 Validating Slurm And Pyxis
Slurm and Pyxis validation on the cluster (here), can be carried out as follows:
3.9.7.1 Validating Slurm
3.9.7.2 Validation Of Pyxis
3.9.8 Validating Kubernetes
The kube-system pods should be inspected to see if they are running along without any real issues:
Example
Are the operators running along fine too?
3.10 In-place Upgrade Of An Edge Director Or A Compute Node
The recommended way of upgrading the compute nodes is to upgrade the head node and software image(s) as described in section 3.8, and to allow the node-installer (when the compute nodes are booted) to re-provision the compute nodes with the upgraded software. For clusters with an edge setup, this usually means a new edge ISO needs to be generated on the head node, transferred to the edge site, and then the edge director node needs to be reconfigured to boot from the ISO, which will start the node-installer.
In some special cases, however, the administrator may elect to manually carry out an in-place upgrade of a compute node or edge director, instead of using the node installer to automatically upgrade the node. With the manual in-place upgrade, the administrator sets up the node to receive the updates directly from the software image (through imageupdate) without the involvement of the node installer.
Other than the cases where the node installer does not start on (re)boot by default, such as for the edge director, the in-place upgrade of a compute node/edge director does not offer any advantage over the standard approach to simply upgrade the head node and the software image(s).
3.10.1 Important Note About Services Running On The In-place Upgraded Compute Node/Edge Director
An in-place upgrade of a compute node will generally restart only the CMDaemon service. Any other service that may be affected by the upgrade of the packages, especially in the case of packages in /cm/shared (such as WLM), which are upgraded as part of the head node(s) upgrade, will need to be restarted manually by the administrator, or a reboot will be required.
It is therefore recommended to use the standard approach to upgrade the software image(s) on the head node, boot the nodes with the node installer, and allow the node installer to upgrade and configure the compute nodes as usual.
Nevertheless the administrator may find it more convenient in special cases such as edge sites, which have edge directors, to perform an in-place upgrade. The edge directors nodes are typically configured to boot from the local disk and by default do not start the node installer on (re)boot. An in-place upgrade of the edge directors will then allow the administrator to upgrade the software on the directors without transferring ISOs and reconfiguring the directors to boot from ISOs. To address the issue with the running services, the edge directors can be rebooted at the end of the upgrade and while they will still not start the node installer, they will boot into the upgraded software.
3.10.2 In-place Edge Director Upgrade Procedure
Unless otherwise stated, all actions are performed locally on the edge director
3.10.2.1 Apply Updates To The Edge Director
-
RHEL derivatives:
-
SLES derivatives:
-
Ubuntu:
3.10.2.2 Back Up The File System
It is recommended to perform a file system backup of the edge director
3.10.2.3 Stop CMDaemon and cm-nfs-checker services
3.10.2.4 Upgrade The Head Node(s) As Described In The Preceding
Follow the steps to upgrade the head nodes, software image, and node installer as described in the preceding sections “Enable Upgrade” (section 3.7) and “Perform Upgrade” (section 3.8), and which are performed on the head node(s) of the cluster. Because CMDaemon on the edge director is stopped, the edge director does not need to be powered off while the upgrade of the head nodes takes place.
3.10.2.5 Upgrade CMDaemon To BCM 11
After the upgrade of the head nodes is completed, the package manager repositories files on the edge director must be manually updated to point to the BCM 11 repositories. This means that all occurrences of 10.0 in the repositories are replaced with with 11.0. Note: Leave the usernames such as in, for example, “username=cm10user”, unchanged.
Then, upgrade CMDaemon as follows for the various distributions:
-
RHEL derivatives:
Update the
/etc/yum.repos.d/cm.repofile to point to the 11.0 repositories.On RHEL, typically
yum/dnfcan manage to resolve most of the dependencies, and the administrator can execute: -
SLES derivatives:
Update the
/etc/zypp/repos.d/Cluster_Manager_Updates.repofile to point to the 11.0 repositories.Execute
A problem may be reported by
zypperwith upgradingcmdaemonto version 11.0, due to a requirement to installcm-config-cmversion 11.0. Typically the first solution,Solution 1, offered by zypper can be selected, which is to deinstall a certain set of BCM packages (prefixed bycm9.2) in order to upgrade CMDaemon to version 11.0. -
Ubuntu:
Update the
/etc/apt/sources.list.d/cm.listfile to point to the 11.0 repositories.Also update the
/etc/apt/auth.conf.d/cm.conffile, to point to the 11.0 repositories.Create a new file
/etc/apt/preferences.d/99-tmp-cmd-upgradewith content (without any space at the beginning of the lines):The administrator may also find it convenient to choose a geographically-close mirror in the
cm.listfile. But note that the local change will be overwritten to the settings in the software image, onceimageupdateis run in a step later on.Execute
3.10.2.6 Start CMDaemon
After CMDaemon has been upgraded to BCM 11, execute:
3.10.2.7 Update The Edge Director Image With imageupdate
On the head node, with cmsh, verify that the edge director is UP. If the edge director is not UP, then the in-place upgrade has not been successful, and the director will need to be upgraded by booting into to the node-installer.
With cmsh on the head node, execute imageupdate for the edge director. The administrator is advised to execute a dry-run first, then to use use the synclog command to review the result and verify no unexpected local data directories or files will be affected, and then to perform the real imageupdate:
3.10.2.8 Update The Provisioners And Recreate The Ramdisks
Execute on the head node
Allow for the provisioning requests with a destination node the in-place upgraded director to complete by monitoring the provisioning status:
For the images served by the edge director, recreate the ramdisk
If needed, the in-place upgraded edge director can now also be rebooted. It is then upgraded and can provision the edge compute nodes.