This document provides a high-level description of the steps that are required to install the Cisco Crosswork Network Controller solution, which is made up of the Cisco Crosswork Infrastructure, Cisco Crosswork Data Gateway, and several Cisco Crosswork applications.

It is a supplement to the Cisco Crosswork Infrastructure 4.1 and Applications Installation Guide, which provides full installation requirements and details for the Cisco Crosswork portfolio.

Each step in this high-level installation workflow links directly to the sections in the above-mentioned installation guide, making it easier for you to find information specific to Crosswork Network Controller.

This document is not intended to be a comprehensive installation guide.

Cisco Crosswork Network Controller

Cisco Crosswork Network Controller is a network automation solution for deploying and operating IP transport networks that delivers increased service agility, cost efficiency, and optimization for faster time-to-customer value and lower operating costs.

The solution combines intent-based network automation to deliver critical capabilities for service orchestration and fulfilment, network optimization, service path computation, device deployment and management, and anomaly detection and automatic remediation. Using telemetry gathering and automated responses, Cisco Crosswork Network Controller delivers network optimization capabilities that are nearly impossible to replicate even with a highly skilled and dedicated staff operating the network.

Its unified user interface allows real-time visualization of the network topology and services, monitoring of services and their health status, as well as service and transport provisioning, through a single pane of glass.

The fully integrated solution combines core capabilities from multiple innovative, industry-leading products including Cisco® Network Services Orchestrator (NSO), Cisco Segment Routing Path Computation Element (SR-PCE), and the Cisco Crosswork suite of applications.

Installation Requirements for Cisco Crosswork Network Controller Components

Table 1. Cisco Crosswork Network Controller Components

Components

Version

Installation Details

Cisco Crosswork Infrastructure (mandatory)

A microservices-based platform that is the foundation required for running Crosswork on-premise applications.

4.1

Cisco Crosswork Infrastructure Requirements

Cisco Crosswork Data Gateway (mandatory)

Gathers information from the managed devices and forwards it to Cisco Crosswork Infrastructure and external destinations (if required).

3.0

Cisco Crosswork Data Gateway Requirements

Cisco Crosswork Optimization Engine (mandatory)

Provides real-time network optimization that allows operators to effectively maximize network capacity utilization, as well as increase service velocity.

3.0

Installation Dependencies for Cisco Crosswork Products

Cisco Crosswork Active Topology (mandatory)

Enables visualization of topology and services on logical and geographical maps.

3.0

Cisco Crosswork Change Automation (optional)

Automates the process of deploying changes to the network.

4.1

Cisco Crosswork Health Insights (optional)

Performs real-time Key Performance Indicator (KPI) monitoring, alerting, and troubleshooting.

4.1

Cisco Crosswork Zero Touch Provisioning (optional)

Brings up compatible devices quickly and easily using a Cisco-certified software image and a day-zero software configuration of the customer's choice.

3.0

Cisco Service Health (optional)

Reduces the time required to detect and troubleshoot service quality issues. It monitors the health status of provisioned L2/L3 VPN services and enables operators to pinpoint why and where a service is degraded. It can also provide service-specific monitoring, troubleshooting, assurance, and proactive causality through a heuristic model.

Note 
Cisco Service Health is available for pre-launch laboratory evaluation only. Engage your account team if you are interested in participating in the evaluation.

3.0

Cisco Network Services Orchestrator (Cisco NSO) (mandatory)

Crosswork Network Controller uses Cisco NSO for device management and service orchestration functionality. Cisco NSO is an orchestration platform that makes use of pluggable function packs to translate network-wide service intent into device-specific configuration. Cisco NSO provides flexible service orchestration and lifecycle management across physical and virtual network elements. For full Crosswork Network Controller functionality, Cisco NSO must be installed along with the Cisco NSO NEDs and function packs.

5.5.2.12

Cisco NSO and NED Requirements

Network Services Orchestrator Software- 5.5.2.12

Cisco Network Element Drivers (NEDs) (mandatory)

Cisco NEDs comprise the network-facing part of Cisco NSO. They communicate over the native protocol supported by the device, such as Network Configuration Protocol (NETCONF), Representational State Transfer (REST), Extensible Markup Language (XML), CLI, and Simple Network Management Protocol (SNMP).

Cisco IOS XR:

  • CLI: 7.33.12

  • NETCONF: 6.6.3, 7.3, 7.315, and 7.4.1

Cisco IOS:

  • CLI: 6.74.8

Cisco NSO Transport-SDN Function Pack (mandatory)

Consists of the following function packs:

  • SR-TE Core Function Pack (CFP) is a productized and supported implementation of SR-TE automation.

  • Cisco NSO Example Function Packs provide example implementations as a starting point for Layer 2 and Layer 3 VPN service provisioning functionality in Crosswork Network Controller. The intention is for customers to work with a Cisco Customer Experience representative to adapt these sample function packs to their specific networks and requirements.

3.0.0

Cisco NSO T-SDN Function Pack Installation Guide Version 3.0.0

Cisco NSO Device Lifecycle Management (DLM) Service Pack (mandatory)

Installed on a Cisco NSO instance in order to synchronize device configurations in Cisco Crosswork with those in Cisco NSO. It effectively channels communication between the Crosswork DLM and Cisco NSO.

4.1.0

Cisco NSO DLM Service Pack Installation Guide Version 4.1.0

Cisco Crosswork NSO Telemetry Traffic Collector Function Pack (mandatory)

Cisco Crosswork Telemetry Traffic Collector Function Pack is installed on the Cisco NSO platform and is used to push services and network configurations to the devices. It utilizes Cisco NSO Reactive FastMap (RFM) nano services to manage the telemetry configuration on devices. This is primarily used for dial-out MDT collection.

4.1.0-209

Cisco Crosswork NSO Telemetry Traffic Collector Function Pack Installation Guide Version 4.1.0-209

Cisco Crosswork Change Automation NSO Function Pack (optional, only if you have installed Crosswork Change Automation)

Cisco Crosswork Change Automation Function Pack enables a special access user to connect to Cisco NSO for all the configuration management operations performed during the execution of a Change Automation Playbook.

4.1.0

Cisco Crosswork Change Automation NSO Function Pack Installation Guide Version 4.1.0

High-level Installation Workflow

This section provides the high-level procedure for installing Cisco Crosswork Network Controller.

Before you begin - Ensure that the installation requirements are met. For more information, see Installation Requirements for Cisco Crosswork Network Controller Components.

Table 2. High-level Installation Workflow

Step

Action

Procedure

1

Ensure that you have installed Cisco NSO, Cisco NEDs, and the applicable function packs.

Installation Requirements for Cisco Crosswork Network Controller Components

2

Install the Crosswork network infrastructure cluster and check that all the cluster nodes are up and running.

Install the Crosswork Cluster

3

Download the CAPP files and install the Crosswork applications from the Crosswork UI.

Components required for Crosswork Network Controller basic operations (mandatory components):

  • Cisco Crosswork Optimization Engine 3.0

  • Cisco Crosswork Active Topology 3.0

Optional components for Crosswork Network Controller advanced use cases:

  • Cisco Crosswork Change Automation 4.1

  • Cisco Crosswork Health Insights 4.1

  • Cisco Crosswork Zero Touch Provisioning 3.0

  • Cisco Service Health 3.0

    Note 
    Cisco Service Health is available for pre-launch laboratory evaluation only. Engage your account team if you are interested in participating in the evaluation.

Install Crosswork Applications

4

Install the Crosswork Data Gateway(s).

Install the Crosswork Data Gateway.

5

Add Cisco NSO to Crosswork as a provider to configure the network devices.

Add Cisco NSO Providers

6

If not already in place, add the Cisco Segment Routing Path Computation Elements (Cisco SR-PCE) to the network.

Configure the Segment Routing Path Computation Element

7

Add the Cisco SR-PCE as a provider to enable Cisco Crosswork application access to an SR-PCE as an SDN controller.

Add the Cisco SR-PCE Providers

8

Get up and running post-installation.

Setup Workflow

High-level Upgrade Workflow

This section provides the high-level procedure for upgrading Cisco Crosswork Network Controller 2.0 to 3.0. This includes upgrading the Cisco Crosswork cluster, Cisco Crosswork Data Gateway and Crosswork Applications, within a single maintenance window.

The time taken to complete the entire upgrade can vary based on size of your deployment profile and the performance characteristics of your hardware.

Limitations

  • Third-party device configuration in Device Lifecycle Management (DLM) and Cisco NSO are not migrated, and need to be re-applied on the new Cisco Crosswork version post migration.

  • Custom user roles (Read-Write/Read) created in Cisco Crosswork 4.0 are not migrated, and need to be updated manually on the new version post migration.

  • Crosswork Health Insights KPI alert history is not retrieved as part of the migration.

Table 3. High-level Upgrade Workflow

Step

Action

Procedure

1

Shut down the Cisco Crosswork Data Gateway 2.0 VMs.
Note 

When the Crosswork Data Gateway VMs are shut down, the data will not be forwarded to data destinations. Check with the application providers to determine if any steps are needed to avoid alarms or other problems.

Shut Down the Cisco Crosswork Data Gateway 2.0 VMs

2

Create a backup when upgrading your Cisco Crosswork to a new software version.
Note 

We recommend that you create a backup only during a scheduled upgrade window. Users should not attempt to access Cisco Crosswork while the backup operation is running.

Create Backup and Shut Down Cisco Crosswork 4.0

3

Install the Crosswork network infrastructure cluster and check that all the cluster nodes are up and running.

Install the Cisco Crosswork 4.1 Cluster

4

While the cluster installation is in progress, upgrade Cisco NSO and install the function packs.

Upgrade Cisco NSO to version 5.5.2.12

5

Upgrade the SR-PCE version to 7.3.2 to use Cisco Optimization Engine individually or as part of the Crosswork Network Controller solution.

More details about the supported SR-PCE version are provided in the Crosswork Network Controller Release Notes

6

Download the CAPP files and install the Crosswork applications from the Crosswork UI.

Components required for Crosswork Network Controller basic operations (mandatory components):

  • Cisco Crosswork Optimization Engine 3.0

  • Cisco Crosswork Active Topology 3.0

Optional components for Crosswork Network Controller advanced use cases:

  • Cisco Crosswork Change Automation 4.1

  • Cisco Crosswork Health Insights 4.1

  • Cisco Crosswork Zero Touch Provisioning 3.0

  • Cisco Service Health 3.0

    Note 
    Cisco Service Health is available for pre-launch laboratory evaluation only. Engage your account team if you are interested in participating in the evaluation.

Install the Cisco Crosswork 4.1 Applications

7

After successfully installing Cisco Crosswork 4.1 applications, migrate the backup of Cisco Crosswork 4.0 to the Cisco Crosswork 4.1 cluster.

Migrate the Cisco Crosswork 4.0 backup to Cisco Crosswork 4.1

8

Manually update all the custom user roles (Read-Write/Read) that were created in Cisco Crosswork 4.0.

Manage Users

9

Install the Cisco Crosswork Data Gateway 3.0.
Note 

This procedure is required only for a Cisco Crosswork Data Gateway Base VM upgrade. Upgrade of other components, such as collectors, is performed by Cisco Crosswork.

Install the Cisco Crosswork Data Gateway 3.0

10

After the upgrade is completed, check the health of the new cluster and all the installed applications.

Post-upgrade Checklist