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 companion handbook to the Cisco Crosswork Infrastructure 4.3 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.
In 4.1 release, the Crosswork Network Controller solution is bundled as Essentials and Advantage packages.
Essentials package |
Advantage package |
||
---|---|---|---|
Cisco Crosswork Optimization Engine Cisco Crosswork Active Topology |
Cisco Crosswork Optimization Engine Cisco Crosswork Active Topology Cisco Crosswork Service Health Cisco Crosswork Health Insights Cisco Crosswork Change Automation Cisco Crosswork Zero Touch Provisioning Cisco Element Management System (EMS) Services
|
Installation Requirements for Cisco Crosswork Network Controller Components
The cluster resource requirements for deploying Cisco Crosswork Network Controller are explained in the below table:
Attention |
A cluster with only 3 hybrid VM nodes (without any worker VM nodes) is NOT resilient. If one of the VM fails, it will certainly result in an impaired system performance, as the remaining 2 VMs will not be able to support all the pods being migrated from the failed VM. |
Crosswork Network Controller Package |
Number of Nodes 1 |
Deployment Size |
---|---|---|
Essentials |
3 Hybrid Nodes + 1 worker node |
Large |
Advantage 2 |
3 Hybrid Nodes + 2 worker nodes |
Attention |
A Crosswork cluster with only 3 Hybrid VM nodes (without any Worker VM nodes) is more prone to data loss. If one of the Hybrid VM fails, it will result in impaired system performance, as the remaining 2 Hybrid VMs struggle to support all the pods being migrated from the failed VM. Having sufficient worker nodes in your cluster ensures that the load on the Hybrid VMs remains less, therefore, ensuring more VM resiliency. For assistance in adjusting VM Memory and CPU configuration post-installation, please contact the Cisco Customer Experience team. |
Note |
|
Components |
Version |
Installation Details |
|
---|---|---|---|
Cisco Crosswork Infrastructure (mandatory) A microservices-based platform that is the foundation required for running Crosswork on-premise applications. |
4.4 |
||
Cisco Crosswork Data Gateway (mandatory) Gathers information from the managed devices and forwards it to Cisco Crosswork Infrastructure and external destinations (if required). |
4.1 |
||
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. |
4.1 |
||
Cisco Crosswork Active Topology (mandatory) Enables visualization of topology and services on logical and geographical maps. |
4.1 |
||
Cisco Crosswork Change Automation (optional) Automates the process of deploying changes to the network. |
4.4 |
||
Cisco Crosswork Health Insights (optional) Performs real-time Key Performance Indicator (KPI) monitoring, alerting, and troubleshooting. |
4.4 |
||
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. |
4.1 |
||
Cisco Crosswork 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.
|
4.1 |
||
Cisco Element Management System (EMS) Services (optional) Provides deep inventory collection, alarm management and image management using using Inventory, Fault, and Software Image Management (SWIM) functions. |
4.1 |
||
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.7.6 |
||
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:
Cisco IOS:
|
||
Cisco NSO Transport-SDN Function Pack (mandatory) Consists of the following function packs:
|
4.1.0 |
Cisco NSO Transport SDN Function Pack Bundle 4.0.0 Installation Guide Cisco NSO Transport SDN Function Pack Bundle 4.0.0 User Guide |
|
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.4.0 |
Cisco Network Services Orchestrator DLM Service Pack 4.3.0 Installation Guide |
|
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.4.0-116 |
Cisco Crosswork NSO Telemetry Traffic Collector Function Pack 4.4.0-116 Installation Guide |
|
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.4.0 |
Cisco Crosswork Change Automation NSO Function Pack 4.3.0 Installation Guide |
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.
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 |
(Optional) Configure Cisco NSO Layered Service Architecture if you have a very large network. For more information about NSO LSA, see NSO Layered Service Architecture documentation. |
|||
3 |
Install the Cisco Crosswork cluster on your preferred datacenter platform (VMware or AWS EC2), and check that all the cluster nodes are up and running.
|
|||
4 |
Navigate to cisco.com and locate the Application CAPP files (.tar.gz) that you require.
Download the CAPP files to a server that can be reached from Crosswork, and validate them from a linux-based machine. |
|||
5 |
Install the Cisco Crosswork cluster on your preferred datacenter platform (VMware or AWS EC2). |
|||
6 |
Add Cisco NSO to Crosswork as a provider to configure the network devices. |
|||
7 |
If not already in place, add the Cisco Segment Routing Path Computation Elements (Cisco SR-PCE) to the network. |
|||
8 |
Add the Cisco SR-PCE as a provider to enable Cisco Crosswork application access to an SR-PCE as an SDN controller. |
|||
9 |
Get up and running post-installation. |
High-level Upgrade Workflow
This section provides the high-level procedure for upgrading to Cisco Crosswork Network Controller 4.1. This includes upgrading the Crosswork cluster, 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 previous version of Cisco Crosswork Network Controller 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.
Step |
Action |
Procedure |
||
---|---|---|---|---|
1 |
Shut down the Cisco Crosswork Data Gateway VMs.
|
|||
2 |
Create a backup when upgrading your Cisco Crosswork to a new software version.
|
|||
3 |
Install the Crosswork network infrastructure cluster and check that all the cluster nodes are up and running. |
Install the Cisco Crosswork 4.4 Cluster | ||
4 |
While the cluster installation is in progress, upgrade Cisco NSO and install the function packs.
|
|||
5 |
Upgrade the SR-PCE version to 7.7.1. |
For more details, see the supported SR-PCE documentation. |
||
6 |
Navigate to cisco.com and locate the Application CAPP files (.tar.gz) that you require. In 4.1 release, the Crosswork Network Controller solution is bundled as Essentials and Advantage packages. For more information, see the Cisco Crosswork Network Controller overview. Download the CAPP files to a server that can be reached from Crosswork, and validate them from a linux-based machine.
|
|||
7 |
After successfully installing Crosswork Network Controller 4.1 applications, migrate the backup of previous version of Cisco Crosswork to the Cisco Crosswork 4.4 cluster. |
Migrate the previous Cisco Crosswork backup to Cisco Crosswork 4.4 |
||
8 |
Manually update all the custom user roles (Read-Write/Read) that were created in the previous version of Cisco Crosswork. |
|||
9 |
Install the Cisco Crosswork Data Gateway 4.1.
|
|||
10 |
After the upgrade is completed, check the health of the new cluster and all the installed applications. |