Cisco Crosswork Network Controller 7.2 Administration Guide

PDF

Enable or disable maintenance mode

Want to summarize with AI?

Log in

Review how maintenance mode affects cluster components and services when nodes are taken out of normal operation for maintenance activities.


Use maintenance mode to temporarily suspend Crosswork Network Controller operations for maintenance or restart activities and resume normal service.

Maintenance mode provides a graceful shutdown for system updates and synchronizes application data before suspending services.

It can take several minutes for the system to enter maintenance mode and to restart when maintenance mode is turned off. During these periods, users should not attempt to log in or use the Crosswork applications.

Before you begin

  • Back up the Crosswork Network Controller cluster.

  • Notify users, and ensure they log out. The operation cannot be canceled once started.

Procedure

1.

Navigate to Administration > Settings > System Settings > Maintenance Mode.

2.

To enable maintenance mode, set the Maintenance mode slider to On.

  • When prompted, confirm the shutdown to proceed.

  • Wait for the system to fully enter maintenance mode (this may take several minutes).

Note

If you plan to reboot the cluster, wait at least 5 minutes after entering maintenance mode to allow data synchronization.

3.

Perform required maintenance activities.

4.

To disable maintenance mode and resume service, set the Maintenance mode slider to Off.

When prompted, confirm the action. If you do not see a prompt but the system remains in maintenance mode, toggle it on and off again to restore applications.

Crosswork Network Controller enters or exits maintenance mode and synchronizes all application data. Users must not attempt to access Crosswork applications during maintenance mode.

What to do next

Verify system state and notify users when service is restored.

Maintenance mode behavior

This topic lists the maintenance mode behavior for Crosswork Network Controller applications and functional components.
Table 1. Platform Infrastructure

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

Infra - Fault / Alarms

pod-du-fault-alarm-processing-service

pod-du-fault-event-processing-service

pod-du-fault-alarm-rest-service

pod-du-data-retention-service

pod-du-fault-alarm-forwarding-service

Background operations are unaffected

Infra - Data Collection

pod-du-metricmanager

pod-du-astackserver

No functionality impacted

Infra - RBAC / AAA

pod-du-cas

pod-du-tyk

CUD operations from UI/NBI are blocked, READS are allowed

Infra - Licensing

pod-du-clms

N/A

Infra - File Services

pod-du-cw-ftp

pod-du-cw-sftp

N/A

Data Gateway Management

pod-du-dgmanager

Blocked: All write/modify operations (create, update, delete CDGs, destinations, HA pools, custom files, OAM commands, auto-enrollment) and background processing (failover, reconciliation, health checks).

Allowed: All read/query operations (GET APIs), CDG session management, file downloads, Kafka event listening, and vitals reception (timestamp-only updates).

Bottom line: Existing data collection continues on already-configured CDGs, but no new configurations, enrollments, or operational state updates are processed during maintenance mode.

Infra - Device Inventory

pod-du-dlminvmgr

Block onboarding of devices in Maintenance mode, Block Create,update,delete of objects

Infra - K8S/Docker Services

pod-du-docker-registry

pod-du-node-orchestrator

N/A

Infra - DB Services

pod-du-etcd

pod-du-postgres

pod-du-local-postgres

pod-du-timeseries-db

N/A

Infra - Redundancy

pod-du-geoservice

Maps management from UI is blocked

Infra - Device Inventory

pod-du-groupingservice

CRUD operations from UI/NBI are blocked

Infra - Data Collection

pod-du-helios

CUD operations from UI/API are blocked, READS are allowed

Infra - Security

pod-du-ipsec

N/A

Infra - Messaging

pod-du-kafka

pod-du-nats

N/A

Infra - NSO FP Deployment

pod-du-nso-fp-dep-mngr

Upload, Deploy and Delete of Function Pack cannot be performed

Infra - Data Collection

pod-du-magellan

N/A

Infra - Topology

pod-du-toposvc

Infra - RBAC / AAA

pod-du-proxy

N/A

Infra - Topology

pod-du-topovisualization

CUD operations from UI are blocked

Infra - Device Inventory

pod-du-viewsservice

CUD operations from UI are blocked

Infra - Device Inventory

pod-du-cw-icon-server

Infra - Device Inventory

pod-du-distributed-cache

N/A

Infra - K8S/Docker Services

robot-orchestrator

CUD operation from Application management and System patch management are blocked

Cert managment functionalities are not blocked during MM

Infra - Redundancy

pod-du-crosscluster

N/A

Table 2. Optimization Engine

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

COE - Path computation and optimization core engine

pod-du-optima-engine

No functionality impacted

COE - Path computation and optimization workers

pod-du-engine-worker

No functionality impacted

COE - API service for OPM extensibility

pod-du-optima-api-service

No functionality impacted

COE - Circuit Style SR Policy Manager

pod-du-optima-csm

DB writes are disabled, and any APIs invoked (eg, UI or RESTCONF) that require DB write access will receive an error message indicating that system is in maintenance mode.

COE - Local Congestion Mitigation

pod-du-optima-lcm

DB writes are disabled, and any APIs invoked (eg, UI or RESTCONF) that require DB write access will receive an error message indicating that system is in maintenance mode. LCM Domains go into dormant state (this is reflected on the domain cards).

COE - Bandwith on Demand (Compute and manage SR Policies with bandwidth requirements)

pod-du-optima-bwod

Write operation from BWoD Config UI are stopped, user will receive System is in maintenance mode when an attempt to write config is made.

COE - UI backend

pod-du-optima-ui-service

N/A (UI service allows CUD operations from UI. But these operations are blocked at internal COE components with valid error message shown in UI)

COE - native mpls traceroute and path computation

pod-du-oam

Write operations for OAM path trace calculations and configuration changes are blocked.Read operations (querying existing OAM routes) and health monitoring continue to function normally but alarms are suppressed.

COE - Analytics Service

pod-du-optima-analytics-service

Read operations are allowed but no write operations, no processing of data coming from NATS or Kafka (we ignore any incoming message)

COE - Deterministic Demand Matrix

pod-du-optima-ddm

Read operations and APIs allowed, maintenace mode will block any config update operations returning an error message that indicates maintenance mode. All SRv6 locator traffic processing to compute demands is also paused under maintenance mode.

COE - PCE Dispatcher, manage communication and provisioning between core COE services and SR-PCE instances

pod-du-optima-pce-dispatcher

Read operations and APIs allowed, maintenace mode will block any create or update operations (change operations that involve DB writes) and return an error message that indicates maintenance mode.

COE - RESTCONF API service

pod-du-optima-restconf-v3

No functionality impacted

COE - Interface and LSP traffic mapper

pod-du-optima-traffic

No processing of traffic stats from DPM is done, No Write to DB is done during maintenance mode. Read operation of stats is allowed through Restconf.

COE - Analytics API Service

pod-du-optima-analytics-api

N/A , APIs are not blocked

Table 3. Active Topology

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

CAT - Deployment

pod-du-cat-fp-deployment-manager

All NBI APIs are blocked

CAT - Service Overlay

pod-du-cat-service-overlay

N/A

CAT - Restconf API

pod-du-cat-restconf

N/A

CAT - Inventory

pod-du-cat-inventory

CRUD operations are blocked;

CAT - User Interface

pod-du-cat-ui-service

N/A

CAT - NSO interface

pod-du-nso-connector

Operations are blocked. Messages from NSO is blocked.

CAT - Traffic Engineering

pod-du-te-manager

NBI blocks CRUD operations(BLOCKS all incoming REST API requests)

STOPS processing NSO plan-state-change notifications (no new TE policies created)

Table 4. Element Management

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

EMS - Service Manager

pod-du-emf-service-manager

N/A

EMS - Alarms / Events

pod-du-cw-nbi-alarm-notification

N/A ( All NBI operations are allowed)

EMS - Inventory

pod-du-cw-nbi-inventory-notification

N/A ( All NBI operations are allowed)

EMS - Inventory

pod-du-cw-event-based-inventory

pod-du-cw-inventory

pod-du-cw-inventory-collector

N/A

EMS - Image Mgmt

pod-du-swim

N/A (EMS Swim - All swim operations are allowed)

EMS - Image/Config Mgmt

pod-du-image-service

For ZTP Image and config serivce , CUD operations from UI/API are blocked and READS are allowed

EMS - Zero Touch Provisioning

pod-du-ztp-service

CUD operations from UI/API are blocked, READS are allowed

EMS - Config Mgmt

pod-du-ems-config-manager

Functionalities: Config Templates, Config Backup and Restore and Config Preferences

Blocked: CRUD operations from UI/API are blocked

Allowed: Existing Template and Backup/Restore jobs which are already getting executed will continute to get executed

Table 5. Change Automation

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

Change Automation

pod-du-ca

CUD Operation via UI/API is blocked. Read is allowed

Table 6. Health Insights

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

Health Insights

pod-du-hi

CUD Operation via UI/API is blocked. Read is allowed

Health Insights - Data Visualization

pod-du-grafana

No functionality impacted

Table 7. Data Gateway

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

Data Gateway - Collection

pod-du-cli-collector

pod-du-snmp-collector

pod-du-syslog-collector

pod-du-gnmi-collector

pod-du-icon

N/A

Table 8. Service Health

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

Service Health - Archiver

pod-du-aa-app

CRUD operations are blocked

Service Health - Assurance Graph Manager

pod-du-ag-mgr

CRUD operations are blocked

Service Health - Config Manager

pod-du-config-mgr

CRUD operations are blocked

Service Health - Expression Orchestrator

pod-du-exp-orchestrator

CRUD operations are blocked

Service Health - Heuristic Package Manager

pod-du-hp-mgr

CRUD operations are blocked

Service Health - Metric Scheduler

pod-du-metric-scheduler

CRUD operations are blocked

Service Health - Expression Tracker

pod-du-exp-tracker

CRUD operations are blocked

Service Health - Probe manager

pod-du-probe-mgr

CRUD operations are blocked

Service Health - Data Storage Service

pod-du-aa-dss

CRUD operations are blocked; Rejects upload/download of files

Table 9. Workflow Manager

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

Workflow Manager - Events

pod-du-cwm-event-service

N/A

Workflow Manager - Engine

pod-du-cwm-engine-worker-service

pod-du-cwm-engine-matching-service

pod-du-cwm-engine-history-service

pod-du-cwm-engine-frontend-service

N/A

Workflow Manager - Adapter Mgmt

pod-du-cwm-adapter-manager-service

N/A

Workflow Manager - API Mgmt

pod-du-cwm-api-service

CRUD operations are blocked

Workflow Manager - API Mgmt

pod-du-cwm-payload-service

pod-du-cwm-dsl-service

N/A

Workflow Manager - Worker Manager

pod-du-cwm-worker-manager-service

N/A

Workflow Manager - Worker

N/A

Table 10. Workflow Manager Solutions

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

Workflow Manager Solutions - Automations

pod-du-cwm-solutions-automation

CRUD operations from UI/NBI are blocked

Workflow Manager Solutions - FleetUpgrade

pod-du-cwm-solutions-fleetupgrade

CRUD operations from UI/NBI are blocked

Workflow Manager Solutions - Image Repository

pod-du-cwm-solutions-imagerepo

CRUD operations from UI/NBI are blocked

Workflow Manager Solutions - Inventory

pod-du-cwm-solutions-inventory

CRUD operations from UI/NBI are blocked

Workflow Manager Solutions - MOP

pod-du-cwm-solutions-mop

CRUD operations from UI/NBI are blocked

Workflow Manager Solutions - Golden Config

pod-du-cwm-solutions-gc

CRUD operations from UI/NBI are blocked

Table 11. NSO

Functional Component

Functional Component Pod Names

Maintenance Mode behavior

NSO - Crosswork Application

pod-du-enso

(Present only on SVM) NBI and UI operations are read only. Maintenance mode blocks all write-related operations (like provisioning, service or policy changes, and database commits)