Manage Service Design Versions

As a superuser, you can manage the service design catalog and perform tasks such as setting the default version of a service design and installing the latest available version of a service design that Routing Director provides. You can perform these tasks by using the Routing Director GUI or the service orchestration cMGD CLI. Superusers with root user privilege can also uninstall unused versions of a service design by using the service orchestration cMGD CLI. See request service design uninstall.

Set Service Design Default Version

The Service Designs page lists up to three concurrent versions of a service design. One of the three versions is set as the default version and is marked as (Default) in the Service Designs table, next to the version number. Any service instance you create, modify, or delete, is associated with the default service design.

To set the default version of a service design by using the Routing Director GUI:

  1. Click Orchestration > Service Catalog.
    The Service Designs page appears.
  2. Select the service design version you want to set as the default version.
    Note:

    You must select a version that is not listed as (Default) in the table.

  3. Click the Set Default Version button and click Yes to confirm.
    You see a message that the default version is successfully changed. The table automatically refreshes to display the updated service design default version.
To set the default version of a service design by using the service orchestration cMGD CLI, see set service design default version.

Install Latest Available Service Design Version

Routing Director supports concurrent versions of a service or resource design. The Service Designs page lists the latest available version of a service design that is pending installation. You can install the latest available version by using the Routing Director GUI or the service orchestration cMGD CLI.

To install the latest service design version by using the GUI:

  1. Click Orchestration > Service Catalog.
    The Service Designs page appears.
  2. Select the service design for which you want to install the latest available version.
  3. Click More > Install Pending Version.
    Alternatively, right-click the version number and click Install Pending Version.
  4. On the Install Version dialog box, click Yes to confirm.
    Note:
    • The latest version you install is set as the default version for the service design. To change the default version, see Set Service Design Default Version.

    • Routing Director supports only three concurrent versions of a service design. To install the latest available version, superusers with root user privilege can uninstall an unused version of a service design by using the service orchestration cMGD CLI. See request service design uninstall.

To install the latest available version of a service design by using the service orchestration cMGD CLI, see request service design install.

Upgrade Service Design Version for a Service Instance

Any service instance you create, modify, or delete is associated with the default service design version. You can upgrade a service design version associated with a service instance by using the Routing Director GUI.

Before initiating an upgrade, we recommend that you complete any ongoing service instance upgrades. If you initiate another upgrade while existing upgrades are still in progress, any unfinished upgrades are automatically included in the bulk upgrade operation. Running multiple upgrades simultaneously can make it difficult to track the upgrade progress.

An upgrade is considered complete only when the Status of the instance changes to Active after the upgrade.

You can monitor the ongoing bulk upgrade from the Workflows page (Orchestration > Monitoring > Workflows).

To upgrade a service design version for a service instance:

  1. Click Orchestration > Instances.
    The Service Instances page appears.
  2. In the Service Instances table, select one or more service instances for which you want to upgrade the service design version.

    To select all instances listed on the Service Instances page, click the check-box next to the Name column. The number of selected instances is displayed next to the Service Instances table name.

    To select all saved and provisioned instances, click the down arrow next to the check-box and select Select all n items, where n is the total number of instances. The number of selected instances is displayed beside the name of the Service Instances table.

    Note:

    We recommend that you upgrade no more than 1000 service instances at a time. Exceeding this limit may cause some instances to fail to upgrade. Failed instances can then be included in a later bulk upgrade.

    To clear all selected plans, click Clear selection.

  3. Click More > Upgrade Service Design.
    The Bulk Service Design Upgrade page appears.

    If the service designs associated with service instances are already upgraded to the latest version, a message appears at the top of the page stating that no upgrade is required.

    On the Bulk Service Design Upgrade page, the service designs and their versions are displayed. Select a version for each service design from the drop-down list and click Next.

    The selected service instances and their design versions that are available for upgrade are categorized into the following sections:

    1. Ready For Upgrade—Displays service design versions of instances or their dependent resources that are ready for upgrade.

      When you initiate an upgrade for an instance, the upgrade workflow automatically includes any dependent network resources. These resources are upgraded before the instance to maintain compatibility with the target version.

      Services that are stitched together can have dependency on each other when upgrading the instances.

      When you upgrade a service instance, the upgrade workflow will automatically include the dependent services to maintain compatibility. As a result, dependent services can appear in the Ready for Upgrade section even when the upgrade is initiated for only one service. For example, upgrading an L3VPN service may include a stitched EVPN service in the upgrade workflow to maintain compatibility and ensure service continuity across dependent services.

      Select the versions that you want to upgrade. To select all the versions, click Select All in Phase.

    2. Upcoming Upgrade—Displays service design versions of instances that must be upgraded next. These service design versions can be upgraded only after completing the corresponding upgrades listed in the Ready For Upgrade section.

      When the upgrades listed in the Ready For Upgrade section are complete, the corresponding service designs move from the Upcoming Upgrade section to Ready For Upgrade section.

      This section does not appear if there are no upcoming upgrades for the selected instances.

    3. Blocked Upgrade—Displays service design versions of instances that are currently dependent on the upgrade of service designs in the Upcoming Upgrade section. These versions can be upgraded only after completing the corresponding upgrades listed in both the Ready For Upgrade and Upcoming Upgrade sections.

      This section does not appear if there are no dependent upgrades for the selected service instances.

      You can upgrade a service design by only one version at a time even if multiple higher versions are available.

    (Optional) Select or clear the Dry Run with Validation check box.

    • Select the Dry Run with Validation check box to execute a dry run on the selected instances. When you execute a dry run, the configuration generated for the service instance is validated on the devices.

      A confirmation message appears indicating that the dry run workflow is created. You can view the dry-run workflow on the Workflows page (Orchestration > Monitoring > Workflows).

      If the dry run fails, an error message is displayed on the Service Instances page. You can troubleshoot the error from the Workflows page.

    • Clear the Dry Run with Validation check box to upgrade the selected instances without executing a dry run. By default, the Dry Run with Validation check box is not selected.

  4. Do any of the following:
    1. Click OK to upgrade the selected instances.

    2. Click Cancel to discard the changes.

      After a successful upgrade, the Design Version column on the Service Instances page displays the upgraded service design versions associated with the service instances.

  5. On the Upgrade Service Design dialog box, click the drop-down to select the service design version you want to upgrade to.
  6. Click Yes to confirm.
    You can view the status of the service design upgrade in the State column of the Service Instances table. The state is displayed as Processing when the upgrade is in process. After successful upgrade, the state is displayed as Success.