Sustainability Insights

This package contains Cisco Sustainability Insights tooling. This collects near-real-time power, energy efficiency other metrics from devices to generate visualisation and insights. This is a reference implementation of POWEFF specification as the normalised data model for power metrics.

This version supports two Cisco devices families viz. Cisco ASR 1000 and Cisco Catalyst 9300 and one connection type viz SSH/CLI. This can be easily extended to other vendors' device types and other connection types e.g. REST, RESTCONF, SNMP etc.

Prerequisites

Docker v24 OR Podman v5.x If using podman, update the build and running scipts to use podman, podman-compose in place of docker and docker-compose respectively.

Quickstart

• Configure device inventory and collection
• For Linux users: run $ chmod 666 config.yaml as read-write permission is required
• Configure micro services
• For Windows users: Change the EOL Sequence from CRLF to LF for the following files:
  1. dbscripts/dbcreate.sh
  2. superset/superset-init.sh
• Recommended to change application credentials in .env file i.e. POSTGRES_PASSWORD, ADMIN_PASSWORD, SUPERSET_ADMIN_PASSWORD and SUPERSET_SECRET_KEY
• Start applciations $ start-susi.sh or simply $ docker compose up -d. Building the docker images is already integreated into the Docker Compose process.
• Open Application Dashboard in a browser
• Login with username admin and value of SUPERSET_ADMIN_PASSWORD as password set in .env. Default values are admin/5cS9Fb73CUnd
• Select top level, site level or device level dashboard for visualisation and insights
• To stop applciations $ stop-susi.sh or simply $ docker compose down

Design

This solution uses below microservices communicating over Apache Kafka messaging infrastructure.

• Scheduler MS
  • Reads device inventory configuration and validates against schema
  • Initiates collection for each device at configured intervals
• SSH Collector MS
  • Initiates connection to the network device using Cisco pyATS
  • Runs platform specific CLI commands
  • Parses CLI command output and normlises to POWEFF data model
• Processor MS
  • Processes POWEFF data
  • Fetches CO2 Intensity (realtime if Electricity Maps API is configured or uses configured default)
  • Calculates CO2eq emissions and other metrics
  • Stores collected and calculated metrics in Timescale database
• Apache Superset
  • Renders dashboards for metrics visualisation and insights