How sean2249/argo-helm works
Step 1: Identify the Main Components
• Helm Repository: At the highest level, represent the “Helm Charts Repository” which is served via Helm (and Artifact Hub) for users to add and install.
• Individual Chart Packages: Break out the key sub-components from the “charts” directory:
– Argo CD (argo-cd)
– Argo Events (argo-events)
– Argo Rollouts (argo-rollouts)
– Argo Workflows (argo-workflows)
– ArgoCD Apps (argocd-apps)
– ArgoCD Image Updater (argocd-image-updater)
• CI/CD and Quality Assurance: Represent the GitHub workflows and scripts (the .github folder and scripts directory) that manage linting, testing, building, and publishing of these charts.
• Supporting Documentation & Contribution: Include supporting files such as CONTRIBUTING.md, README.md, and configuration files that help maintain repository standards.
Step 2: Determine Relationships and Interactions
• CI/CD Pipelines → (validate/build/deploy) → Helm Chart Packages: Indicate that GitHub workflows (like publish.yml, lint-and-test.yml) automatically manage testing, linting, and releasing the charts.
• Users/Operators → (consume via “helm repo add”) → Helm Charts Repository: Show that end-users add the Helm repository and then install specific charts into their Kubernetes clusters.
• Each Chart’s Internal Components: For complex charts like Argo CD, further break out templates and values that configure deployments, services, roles, and other Kubernetes resources.
Step 3: Highlight Architectural Patterns and Design Principles
• Modular Design: The repository clearly uses a modular structure where each Argo project is encapsulated into its own Helm chart, making it extensible and maintainable.
• Infrastructure-as-Code: The charts use Kubernetes YAML manifests templated with Helm, which is central to deploying cloud-native applications.
• CI/CD Integration: The repository embraces automation with GitHub Actions for building, linting, testing, and publishing charts.
• Multi-Chart Dependencies: Although each chart is independent, they follow consistent patterns (e.g., common templates like _helpers.tpl) indicating reusable patterns across charts.
Step 4: Include Relevant Technologies and Frameworks
• Helm: For packaging and templating Kubernetes deployments.
• Kubernetes: The target deployment platform for the charts (such as deploying via Argo CD).
• GitHub Actions: Orchestrated CI/CD pipelines for automated checks and publishing.
• Argo Projects: Specific technologies like Argo CD, Argo Workflows, etc., which are the core focus of the repository.
Since this is a specialized repository of charts rather than a full-blown application:
• Separation of components by chart package.
• CI/CD pipeline as an enabler in the repository (for instance: code push → GitHub Workflow → Chart Release).
• Distinguish between the “source” elements (templates, chart values, and asset definitions) and “output” elements (deployable Kubernetes manifests).
• Clear labels for each component: “Helm Charts Repository”, “Argo CD Chart”, “Argo Events Chart”, etc.
– Documentation and configuration files (a supporting layer)
Step 7: Overall Instructions
• Every chart as a component.
• Integration with CI/CD pipelines.
• Optionally, note the common Helm templating approach (shared templates, values file overrides) used across charts.