How hughessystique/d-scope works
Main Components Identification
• Kubernetes Cluster – The deployment environment that will run all components.
• Istio – Noted as a prerequisite, Istio is used to manage ingress traffic and service meshes.
• Ingress Gateway – Acts as the external entry point into the system (the URL endpoints for site, ns, device, tunnel, etc.).
• Microservices (Pods/Deployments) – Represented by several discrete components:
• Frontend Service (frontend.yaml)
• NS Manager (nsmgr.yaml)
• Openness Manager (opennessmgr.yaml)
• OpenStack Manager (openstackmgr.yaml)
• SDNC Manager (sdncmgr.yaml)
• Site Manager (sitemgr.yaml)
• Docker Images – Pulled from Docker Hub (or from a local registry if needed), each corresponding to the above services.
Relationships and Interactions
• The Ingress (managed by Istio) receives incoming HTTP requests and routes the traffic to the appropriate microservice based on paths.
• The Frontend serves as the UI/API layer interfacing with other components.
• Each microservice (nsmgr, opennessmgr, openstackmgr, sdncmgr, and sitemgr) is deployed as a separate Kubernetes deployment with its own service. They likely interact in an orchestrated fashion to manage network services end-to-end.
• External interactions: Pulling Docker images from Docker Hub and interacting with the underlying infrastructure (via Istio and external docker registry, if necessary).
Architectural Patterns or Design Principles
• Microservices: Each service component (frontend, managers) is packaged and deployed independently using Helm.
• Infrastructure as Code: Using Helm charts to declaratively manage Kubernetes resources.
• Service Mesh: Leveraging Istio for making ingress and service-to-service communication more robust.
• Separation of Concerns: Each responsibility (exposing REST endpoints, managing different network components) is isolated into the relevant service.
Relevant Technologies, Frameworks, and Libraries
• Kubernetes – As the orchestration platform.
• Helm – Package manager and deployment mechanism.
• Istio – For ingress management and service mesh capabilities.
• Docker – Container images for each component.
• YAML – As configuration for deployments, services, and ingress rules.
Elements
• Use clear labels for each component (e.g., “Frontend”, “NS Manager”, etc.).
– Another for microservices (each manager and frontend).
– An additional style for external dependencies (Docker Hub, local registry).
• Configuration artifacts like Helm chart definitions and values as a side note that they drive deployments.
• Frontend Service (exposed via helm-charts/templates/deployments/frontend.yaml).
• Optionally, you might indicate that REST endpoints (like "/site", "/ns", etc.) are invoked, highlighting test endpoints and expected responses.
• Docker images associated with each microservice (e.g., hspl/d-scope-nsmgr) as part of the deployment process.
• A note about Helm and how the templates (deployments, services, ingresses) are used to create the final runtime configuration.