Note

This migration procedure applies only to SBC SWe deployments in the OpenStack cloud environment that are instantiated using Heat templates.

Beginning with release 8.0, SBC clusters deployed in an OpenStack cloud must use either OAM node or Direct Single configuration management. For existing clusters that use the SBC HeadEnd configuration model, the following procedure outlines the steps to migrate the cluster and its current configuration to Direct Single mode. In this process, you duplicate the existing cluster to create a new cluster that holds the same configuration. You then instantiate new SBC nodes for the new cluster and delete the original cluster. Use the links provided with a step for more details on how to complete it.

If your deployment is not already configured for network-wide domain licensing (NWDL) and you plan to use it in your deployment, step 11 in the following procedure provides an overview of the process to change to NWDL. However, consult with your Ribbon representative to ensure you are prepared to complete this step before starting migration procedures.


  1. Upgrade the RAMP to release 23.06 (or later). Refer to Upgrading RAMP. After the upgrade, RAMP still includes the HeadEnd-created SBC configuration for the cluster, but it now also supports Direct Single configuration mode.
  2. Log onto the upgraded RAMP.
  3. If you are changing to NWDL licensing, you must ensure that all necessary SBC NWDL licenses are installed in the RAMP License Manager before continuing with migration. The basic steps to install NWDL licenses are as follows:
    1. Log into the RAMP managing the SBC SWe cluster and copy the RAMP domain public key. RAMP provides the public key used to bind the license to the local domain and is used for associating license data with eligible nodes. Refer to Obtain Licenses
    2. Submit the copied public key, along with the order details, to the self-service licensing portal to generate a license bundle file that incorporates the domain public key.
    3. Install the NWDL license bundle on RAMP. Refer to Associate NWDL Licenses.
  4. Click Network > Cluster Management. The Cluster Management / Manage VNFs window opens listing the SBC clusters.
  5. Click the radio button adjacent to the name of the cluster you are migrating.

  6. Click Duplicate Cluster. The New Cluster pane opens below.
    Figure 1: Duplicate Cluster


  7. Select Direct Single as the Configuration Type. 
  8. Refer to Create SBC Clusters for information to specify other cluster options, then click Save.  The duplicated SBC cluster inherits its initial SBC configuration from the duplicated cluster.

    Caution

    The remaining steps are service affecting and must only be performed during a maintenance window.

  9. Terminate all SBC nodes in the original cluster.
  10. Instantiate the standalone SBC or the active SBC of a 1:1 HA pair. Provide the RAMP addressing and the new cluster name in the instantiation.  Refer to Specifying Cluster Configuration Mode Parameters in Heat Deployments and Instantiating SBC SWe Using a Heat Template. The SBC registers and downloads the initial configuration from RAMP.
  11. If you are migrating a 1:1 HA deployment, instantiate the standby SBC, again providing the RAMP addressing and the new cluster name in the instantiation.
  12. If you are changing to NWDL licensing:
    1. Log into RAMP and add the feature licenses to the SBC cluster configuration. Refer to Associate NWDL Licenses.  
    2. Start an edit session on the SBC cluster configuration. Refer to Modifying SBC Cluster Configuration.
    3. Within SBC Configuration Manager, navigate to All > System > License Mode. The License Mode window opens.
    4. Click Domain and then click Save.
    5. Click Apply Saved Changes and Close at the top-right of the SBC Configuration Manager window. When prompted, confirm that you want to save and activate your configuration changes. This saves and replicates the configuration (including the licenses and license mode) to the SBC nodes.
  13. Delete the original HeadEnd cluster from the EMS Cluster/VNF List.