How flavorplus/gitops-cert-level-2-examples works
Project Type and Purpose
• The README tells us it is for the “Codefresh GitOps Certification examples – Level 2” workshop. Thus, the repository isn’t a production application per se—it’s rather a collection of sample configurations and best practices for managing Kubernetes resources using GitOps.
• The project focuses on demonstrating varied GitOps techniques such as app-of-apps, application sets, environment promotion, custom diff strategies, image-updater functionalities, and notifications setups.
File Structure
• At the top level, you see a few categories:
• Directories like “app-of-apps” and “application-sets” indicate common architectural patterns used in GitOps to manage multiple applications and environments.
• “custom-diff”, “environment-promotion”, and “sync-hooks-waves” suggest advanced GitOps operations including custom comparison logic, promoting environments, and handling application sync hooks.
• “image-updater” shows an example of automating image version updates.
• Additional directories such as “notifications”, “argocd-noauth”, “source-code-configmap”, and “solutions” highlight various integration points and demonstrations.
• The “.github/workflows” directory indicates that GitHub Actions are used for CI/CD and possibly for automating tasks like Docker publishing or promoting changes.
• The structure implies a modular, multi-component setup where each directory stands as an independent example or use-case feature, yet collectively they show how GitOps supports diverse operations within a Kubernetes cluster.
Extract Key Insights from the README
• The single-line description reinforces that these are certification examples aimed at teaching GitOps at scale.
a. Main Components:
• Git Repository: Represent the repository as the source of truth containing all manifest examples.
• Continuous Integration/Delivery: Include the GitHub Actions workflows that automate builds, tests, and possibly promotions.
• ArgoCD Server & Controllers: Illustrate the ArgoCD components that continuously monitor and sync the stated configurations from the repository to the Kubernetes clusters.
• Modular Examples: Create grouped blocks for key patterns such as:
º App-of-apps: Demonstrates using a parent-child application management pattern.
º Application Sets: For dynamically managing groups of applications.
º Custom Diff & Environment Promotion: For advanced diffing logic and multi-environment promotion workflows.
º Image Updater & Notifications: For automated image updates and alerting mechanisms.
b. Relationships and Interactions:
• Git repository (on the left) triggering CI workflows (via GitHub Actions).
• How those workflows feed into the ArgoCD server.
• Within the cluster, show that multiple modules (app-of-apps, env promotion, etc.) operate as separate yet interconnected components.
• External integrations where applicable – for instance, how notifications or external helm applications might be integrated.
c. Architectural Patterns:
• GitOps pattern where source control is the single source of truth.
• How “app-of-apps” and “application sets” serve as examples of declarative infrastructure management.
• Mention usage of custom sync hooks and diff strategies as advanced configuration management techniques.
d. Technologies and Frameworks:
• ArgoCD is central to the GitOps implementation.
• GitHub Actions (as shown in .github/workflows) automate CI/CD operations.
• Kubernetes manifests (YAML files) are used throughout to define deployments, services, and other resources.