Component C96, C100 – CodeSource

By Raj Marni. March 26, 2025. Revised. Version: 0.0.01

1. Overview

CodeSource is a meta-component that consolidates the management of both DockerHub (C96) for container images and GitLab (C100) for application source code. It ensures that Docker images and code repositories are consistently synchronized and integrated into Kubernetes deployments across environments. By automating the build, synchronization, and deployment of resources, CodeSource streamlines CI/CD workflows, ensures version consistency, and enhances security and operational efficiency within the k8or Orbit ecosystem.

Orbit Component C96 C100 Diagram

2. Key Functions

1. Container Image Management (C96 – DockerHub)

   • DockerHub Integration: CodeSource handles the management and synchronization of Docker container images stored in DockerHub (C96).

   • Functionality:

     • Provides a central registry to store, pull, and manage Docker images used in Kubernetes deployments.

     • Ensures that container images are consistently pulled and deployed to the clusters as defined in the Git repository (C100).

     • Manages image versioning and updates, ensuring that only the required versions of images are used.

2. Source Code Management (C100 – GitLab App Repo)

   • GitLab Integration: CodeSource also manages source code repositories hosted on GitLab (C100).

   • Functionality:

     • Provides a centralized location for storing application source code, including all related configurations, scripts, and Kubernetes manifests.

     • Supports continuous integration (CI) workflows, enabling automatic building, testing, and deployment of source code changes.

     • Facilitates the synchronization of the codebase with deployed applications in Kubernetes clusters.

3. CI/CD Pipeline Integration

   • Automated Builds and Deployments: CodeSource integrates with CI/CD pipelines to automate the process of building container images and deploying code changes to the Kubernetes clusters.

   • Functionality:

     • Automatically triggers Docker image builds when changes are made in the GitLab repository (C100) or updates in the DockerHub registry (C96).

     • Ensures that application updates from GitLab (C100) are reflected in the corresponding container images and pushed to the DockerHub (C96) registry for deployment.

4. Version Control and Artifact Storage

   • Artifact Storage: CodeSource provides a unified method for storing application artifacts, such as container images and application code, to maintain version control.

   • Functionality:

     • Manages versioned container images and source code, ensuring that the correct versions of artifacts are deployed to various Kubernetes clusters.

5. Unified Metadata Management

   • Metadata Synchronization: CodeSource synchronizes metadata between C96 (DockerHub) and C100 (GitLab App Repo) to ensure consistency in deployment definitions, environment variables, and application parameters.

   • Functionality:

     • Consolidates metadata management by ensuring that both container images and source code updates are synchronized with the corresponding configurations in the system.

---

3. Interactions with Other Components

1. From C8 – K8or Portal

   • Purpose: The K8or Portal (C8) interacts with CodeSource indirectly to manage the flow of Docker images and code from GitLab (C100) into the Kubernetes clusters.

   • Mechanism: The portal allows users to upload code and images, which are then managed and synchronized by CodeSource to ensure that the application is deployed with the most recent updates.

2. To C56 – SyncMaster

   • Purpose: C56 (SyncMaster) ensures that updates in CodeSource (whether it’s a new Docker image or source code update) are synchronized across all Kubernetes clusters in the system.

   • Mechanism: SyncMaster replicates the changes made in CodeSource to the appropriate clusters, ensuring consistency and availability of the latest updates.

---

4. Technology & Protocols

• GitLab and DockerHub:

  • C100 (GitLab App Repo) manages the source code and application configurations, while C96 (DockerHub) handles the container images used for Kubernetes deployments.

• CI/CD Tools:

  • Integrates with popular CI/CD tools such as Jenkins, GitLab CI, or ArgoCD to automate the build and deployment pipelines for both container images and source code.

• Helm & Kustomize:

  • Uses Helm charts and Kustomize overlays to package and deploy applications consistently across environments.

• RESTful APIs & Webhooks:

  • REST APIs and webhooks are used for communication between CodeSource and other components in the k8or Orbit system for automated synchronization and updates.

---

5. Benefits & Impact

1. Simplified Source Code & Image Management

   • By consolidating Docker image and Git repository management, CodeSource streamlines the deployment process and reduces the complexity of managing different types of artifacts.

2. Automated CI/CD Pipelines

   • The integration of CodeSource with CI/CD systems automates the entire process of building, testing, and deploying containerized applications, ensuring continuous and seamless updates.

3. Multi-Environment Consistency

   • CodeSource ensures that container images and application code are consistently synchronized across dev, test, and production environments, reducing errors due to outdated or inconsistent configurations.

4. Versioned Artifacts and Traceability

   • All code and container images are versioned, enabling traceability and easy rollbacks in case of failures, making the system more resilient and auditable.

5. Enhanced Security and Compliance

   • By ensuring that the latest images and source code are deployed with proper synchronization, CodeSource helps maintain security standards and compliance across environments.