How amrc-factoryplus/amrc-connectivity-stack works
Project Type and Purpose
• This is a distributed, microservices-based deployment designed to run on Kubernetes. Its purpose is to provide the complete connectivity stack for industrial edge management and device connectivity as part of the Factory+ framework.
• The system includes UI components (such as acs-admin built with Vue.js), authentication and identity services (acs-auth, acs-identity), device, configuration, and cluster management services (acs-configdb, acs-cluster-manager, acs-directory), edge-related components (acs-edge, acs-edge-sync, edge agent/driver projects), and other supporting services (acs-git, acs-mqtt, acs-service-setup, acs-visualiser, etc.).
• Helm charts and Kubernetes deployment artifacts (the deploy folder) indicating that the entire stack is deployed into a Kubernetes cluster and managed via Helm.
Analyzing the File Tree and Architectural Patterns
• Components by their roles: For instance, front-end UI (acs-admin), authentication (acs-auth, acs-krb-keys-operator), management microservices (acs-manager), and peripheral support such as monitoring (acs-monitor), git services (acs-git), and historical data ingest (historian-sparkplug, historian-uns).
• The presence of Dockerfiles, Kubernetes YAMLs/Helm charts, Makefiles and CI/CD pipelines (under .github) suggests containerized microservices with automated deployment.
• The structure suggests a microservices architecture with a clear separation of concerns. Each service has its own codebase, Docker configuration and sometimes even dedicated databases (via migrations and SQL directories).
Key Components and Their Relationships
a. Core Services:
– acs-admin: The front-end administrative application (Vue.js based) that interacts with several backend services.
– acs-auth and acs-identity: Handle authentication, authorization, and user identity elements.
– acs-manager: A central orchestration service handling devices, nodes, edge clusters, preferences, schemas, etc.
– acs-configdb and acs-directory: Likely responsible for configuration and managing directory data.
b. Edge-Specific Components:
– acs-edge, acs-edge-sync: Handling edge device connectivity and synchronization.
– Other edge drivers (e.g., edge-modbus, edge-openprotocol, edge-tplink-smartplug, etc.) that help connect various industrial protocols/devices.
– Edge Helm charts: “edge-helm-charts” for deploying edge agents and clusters.
c. Support & Infrastructure:
– acs-git: Internal Git server providing version control for configurations, potentially integrated with CI/CD.
– acs-mqtt: Likely handles messaging protocols (MQTT) for device communication.
– acs-krb-keys-operator, hivemq-krb, and associated Kerberos components, which deal with secure authentication and potentially key management.
– Monitoring components: acs-monitor for both centralized and edge monitoring.
– Historical/Telemetry Data: historian-sparkplug and historian-uns components for ingesting, processing, or visualizing historical data.
d. Deployment and Configuration:
– The deploy folder contains Helm templates and Kubernetes manifests, so showing a “Deployment/Orchestration Layer” that automates the rollout of the services.
– The shared base images in acs-base-images indicate standardization of container environments.