How superkkt/cherry works
• • OpenFlow Protocol Handler: Represent the modules in the “openflow” directory. Clearly separate out components handling versions 1.0 (located in openflow/of10) and 1.3 (in openflow/of13), along with shared components (e.g., openflow/action.go, openflow/message.go).
• • API Layer: The “api” directory (with its subdirectories like “core” and “ui”) handles REST API endpoints and may also expose the controller’s functionality to external systems.
• • Northbound Applications: Modules in the “northbound” directory contain several application components (e.g., DHCP, discovery, L2Switch, ProxyARP, VirtualIP, and monitoring apps). Display these as plug-in modules that interact with the core.
• • Network Components: The “network” directory encapsulates controllers for network sessions, topology, and device management. This module further integrates with the OpenFlow and protocol layers.
• • Protocol Utilities: The “protocol” directory holds helpers for ARP, DHCP, TCP/UDP, etc., used across the system.
• • Supporting Services: Other packages such as “database” (for MySQL integrations), “election” for leader election and clustering support, “graph” for network topology representation, as well as LDAP, logging (“log”), and version management.
• • Command-Line Tools: Components under the “cmd” directory (with their individual configuration files such as cherry.yaml and walnut.yaml) serve as the entry points or tools to initialize and run the controller.
Relationships and interactions
• Communication across the openflow protocol handlers and how they receive and send messages to the switch hardware.
• That northbound applications leverage the protocol utilities and the network component’s services to manage or monitor data.
• Demonstrate that command-line utilities (from the “cmd” directory) act as the entry point to initialize the controller, which in turn sets up the necessary modules and interfaces with the database.
Architectural patterns and design principles
• Modular and pluggable design: Cherry’s structure (e.g., northbound applications as independent submodules) supports a plugin-based architecture.
• Separation of concerns: Clear division between protocol handling, API management, northbound logic, core network operations, and supporting services (like database operations or LDAP).
Relevant technologies
• Go language is the primary development platform.
• MySQL (or MariaDB) serves as the backend database.
• Docker is an option for containerization (as indicated by the Dockerfile and installation instructions).
• Mention REST/HTTP for the API communications.
• OpenFlow protocols (versions 1.0 and 1.3) are central to the network operations.
Final checklist
• Primary components are clearly represented.
• Maintain clear labels and directional indicators for data/control flow.
• Be as detailed as possible to capture all modules from core OpenFlow handling to the northbound applications and external interfaces.