Migrating an Existing SBC Cluster to OAM Configuration Mode

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 OAM configuration mode, without an interruption in service. 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), you must change to NWDL licensing to operate in OAM configuration mode. The following migration procedure includes an overview of the process required 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 Insight EMS to release 12.x using the existing replacement upgrade procedure. Refer to Installing and Upgrading Insight EMS. After upgrade, the EMS still holds the HeadEnd-created SBC configuration for the cluster, but it now also supports OAM configuration mode.
2. Log onto the upgraded EMS.
3. If you are changing to NWDL licensing, you must ensure that all necessary SBC NWDL licenses are installed in the EMS License Manager before continuing with migration. The basic steps to install NWDL licenses are as follows:
   1. Log into the EMS managing the SBC SWe cluster and copy the EMS domain public key. The EMS 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 Obtaining Domain Public Key to Generate 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. Refer to Obtain NWDL License File.
   3. Install the NWDL license bundle on the EMS. Refer to Install NWDL License into the EMS.
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. The Details tab for the selected cluster opens by default. 

   Cluster Configuration on EMS

   

6. Change the cluster Configuration Type to OAM and then click Save.
   
7. Instantiate the OAM nodes with metadata directing them to the EMS and using the existing "Cluster/VNF Identifier" for the cluster you are migrating. Refer to Specifying Cluster Configuration Mode Parameters in Heat Deployments and Instantiating SBC SWe Using a Heat Template. The active OAM registers with the EMS and downloads the latest configuration. The OAM node converts the existing configuration to the OAM data model and saves it back to the EMS. 
8. If you are changing to NWDL licensing:
   1. Log into EMS and add the feature licenses to the SBC cluster configuration. Refer to Add NWDL Licenses to OAM and Direct Single SBC Configuration.  
   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.
9. Replacement upgrade the standby SBC with metadata pointing to the OAM node. The upgraded standby SBC registers with the active OAM node and gets the converted configuration from it. The upgraded SBC also registers with the EMS but does not request configuration from it. Refer to Upgrading SBC SWe N:1 HA Nodes on OpenStack using Heat Templates for detailed upgrade steps.
10. Switch over one non-upgraded, active SBC to become the current standby.
11. Replacement upgrade the current standby with metadata pointing to the OAM node. The upgraded standby SBC boots as a standby, registers with the active OAM node and gets the converted configuration from it. The upgraded SBC also registers with the EMS but does not request configuration from it.
12. Repeat the previous two steps for all remaining SBCs in the cluster.