Component C8 – k8or Portal
By Raj Marni. March 23, 2025. Revised. Version: 0.1.02
Overview
K8or OpsBoard (C8) is the front-end web application in the Orbit Plane that serves as the primary entry point for users and developers. It is designed to facilitate the upload of images along with associated metadata and to orchestrate the initial steps in the deployment workflow. As a critical component, it bridges user interactions with the underlying automated processes of the Orbit system.
Key Functions
User Interface & Interaction
Visual Experience: Provides an intuitive, responsive UI that allows users to easily upload images and enter metadata (e.g., tags, environment settings, version details).
Authentication & Authorization: Integrates with identity management systems to ensure that only authenticated users can access the functionality.
Feedback & Notifications: Displays real-time status updates on uploads, validations, and subsequent actions (such as chart generation).
Request Handling & Validation
Input Validation: Ensures that uploaded images meet specified criteria (file type, size, resolution) and that metadata is complete and correctly formatted.
Error Handling: Provides immediate feedback if uploads fail validation, guiding users to resolve issues before proceeding.
Orchestration & API Integration
Service Coordination: Acts as the initial trigger for downstream processes by communicating with backend services (such as C12 – Manifestor and C16 – Image Harbor).
RESTful API Gateway: Exposes endpoints for image upload, metadata submission, and status queries. It translates user actions into structured API calls to orchestrate the overall workflow.
Security Enforcement: Implements security measures (e.g., HTTPS, token-based authentication) to protect user data and control access to backend services.
Architecture & Interaction
Internal Structure
Frontend Modules:
Upload Manager: Handles the file selection, choose and upload support, and initiation of the upload process.
Metadata Collector: Provides form-based input to gather additional information related to the image (e.g., environment, version, deployment parameters) and about the user itself.
Status Dashboard: Displays ongoing progress and alerts for the upload process, integrating real-time feedback from backend services.
Integration Layer:
API Client: Manages communication with backend microservices. For example, it sends validated image and metadata payloads to the Manifestor (C12) for Helm chart creation and to Image Harbor (C16) for storage.
Authentication Module: Interacts with identity services (an integrated solution) to verify user credentials and maintain session security.
External Interactions
Upstream (User/Developer):
Users interact directly with the Portal to initiate image uploads. Their actions (file selection, form submission) are captured and processed within the UI.
Downstream Communication:
To C12 (Manifestor): Once an image is uploaded and validated, C8 forwards the necessary data (image reference and metadata) to C12 to trigger the generation of Helm chart manifests.
To C16 (Image Harbor): C8 may either directly or indirectly invoke routines that ensure the image is stored securely in S3 buckets.
To Additional Services: Depending on the workflow, C8 can also pass data to components like C20 (Chart Store) and C32 (Viewport) for further processing and persistence of metadata.
Benefits & Impact
User-Centric Design: By providing a clear and responsive interface, C8 reduces the complexity of interacting with the broader Orbit system, making it accessible even to non-technical users.
Streamlined Workflow Initiation: C8 acts as the catalyst for the entire deployment process. Its ability to validate inputs and coordinate subsequent steps ensures that only correct and complete data flows into the system.
Enhanced Security & Reliability: By integrating tightly with authentication and error-handling mechanisms, the K8or Portal ensures that the overall architecture remains secure and resilient from the very first interaction.
Last updated