diff options
| author | Saumit <justsaumit@protonmail.com> | 2025-11-19 14:03:48 +0530 |
|---|---|---|
| committer | Saumit <justsaumit@protonmail.com> | 2025-11-19 14:03:48 +0530 |
| commit | c97be65cd426545b153cbbc9e123e3a1464ccbe1 (patch) | |
| tree | d666ed72cfe9ee659936fbdab30d0a0db6e9109e | |
| parent | 2080a9d058278e9ee59a275d5c41f9dca95343ae (diff) | |
| -rw-r--r-- | README.md | 190 |
1 files changed, 188 insertions, 2 deletions
@@ -1,3 +1,189 @@ -**Note!** This project utilizes from OpenTelemetry demo project of the tag 2.1.3. Thanks to all the contributors and supporters for maintaining this amazing and elegant sample project! +# 🚀 Astroshop GitOps -Read more [here](https://github.com/open-telemetry/opentelemetry-demo) +A GitOps implementation of the OpenTelemetry Demo microservices application deployed on AWS EKS using Terraform and ArgoCD. + +[](https://github.com/open-telemetry/opentelemetry-demo) +[](https://kubernetes.io/) +[](https://argo-cd.readthedocs.io/) +[](https://terraform.io/) + +> **Note**: This is my attempt to deploy the [OpenTelemetry Demo](https://github.com/open-telemetry/opentelemetry-demo) (v2.1.3) on AWS using Terraform for infrastructure and ArgoCD for GitOps-based application management. Thanks to all the OpenTelemetry contributors for the amazing demo application! + +## 📋 What's Inside + +- **Infrastructure**: Terraform modules for AWS VPC and EKS cluster +- **Applications**: Helm charts for 19 microservices +- **GitOps**: ArgoCD ApplicationSet for multi-environment deployments +- **CI/CD**: GitHub Actions workflow for automated deployments +- **Observability**: OpenTelemetry instrumentation across all services + +## 🏗️ Architecture + +``` +AWS Cloud +├── VPC (Terraform) +│ ├── Public Subnets +│ └── Private Subnets +│ +└── EKS Cluster (Terraform) + ├── Dev Environment (astroshop-dev) + ├── QA Environment (astroshop-qa) + └── Prod Environment (astroshop-prod) + │ + └── 19 Microservices + ├── Frontend (React + Envoy) + ├── Backend Services (Go, .NET, Python, Java, etc.) + └── Supporting Services (Kafka, Redis, Flagd) +``` + +## 📦 Repository Structure + +``` +. +├── astroshop-helm/ # Helm charts for all services +│ ├── accounting/ +│ ├── cart/ +│ ├── checkout/ +│ ├── productcatalog/ +│ └── ... (15 more services) +│ +├── astroshop-terraform/ # Infrastructure as Code +│ ├── modules/ +│ │ ├── eks/ # EKS cluster module +│ │ └── vpc/ # VPC networking module +│ └── main.tf +│ +├── argocd/ # ArgoCD configurations +│ └── argocd-applicationset.yaml +│ +└── .github/workflows/ # CI/CD pipelines + └── build-and-deploy.yaml +``` + +## 🚀 Quick Start + +### Prerequisites + +- AWS CLI configured with appropriate credentials +- kubectl, helm, terraform, and argocd CLI installed +- Docker for building images + +### 1. Deploy Infrastructure + +```bash +cd astroshop-terraform +terraform init +terraform apply -var-file=terraform.tfvars + +# Configure kubectl +aws eks update-kubeconfig --region <region> --name <cluster-name> +``` + +### 2. Install ArgoCD + +```bash +kubectl create namespace argocd +kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml + +# Get admin password +kubectl -n argocd get secret argocd-initial-admin-secret -o jsonpath="{.data.password}" | base64 -d +``` + +### 3. Deploy Applications + +```bash +# Apply ApplicationSet +kubectl apply -f argocd/argocd-applicationset.yaml + +# Verify applications +kubectl get applications -n argocd -l app.kubernetes.io/part-of=astroshop +``` + +### 4. Access the Application + +```bash +kubectl port-forward -n astroshop-dev svc/opentelemetry-demo-frontendproxy 8080:8080 +# Open http://localhost:8080 +``` + +## 📸 Screenshots + +### Homepage - Astronomy Shop + +*Landing page: "The best telescopes to see the world closer"* + +### Product Catalog + +*Browse telescopes, binoculars, and astronomy equipment* + +### Product Details + +*Solar System Color Imager - $175.00 with recommendations* + +### Shopping Cart + +*Cart with currency conversion (USD to INR) and shipping calculation* + +### Checkout - Address + +*Shipping address form during checkout process* + +### Checkout - Payment + +*Payment details with credit card form* + +### Order Confirmation + +*Order confirmation with shipping details* + +## 🌍 Multi-Environment Setup + +| Environment | Namespace | Sync | Values File | +|------------|-----------|------|-------------| +| **Dev** | `astroshop-dev` | Auto | `values.yaml` | +| **QA** | `astroshop-qa` | Auto | `values-qa.yaml` | +| **Prod** | `astroshop-prod` | Manual | `values-prod.yaml` | + +## 🎯 Services + +**Frontend**: frontend, frontendproxy +**Backend**: productcatalog, cart, checkout, payment, shipping, currency, email, recommendation, ad +**Supporting**: kafka, valkey, flagd, accounting, fraud-detection, imageprovider, quote, loadgenerator + +## 🔄 CI/CD Pipeline + +GitHub Actions workflow automatically: +1. Builds Docker images on push to main +2. Tags with commit SHA +3. Updates image tags in GitOps repo using `yq` +4. Triggers ArgoCD sync for dev/qa environments + +**Required Secrets**: `DOCKERHUB_USERNAME`, `DOCKERHUB_TOKEN`, `GITOPS_PAT` + +## 🔧 Useful Commands + +```bash +# View all applications +kubectl get applications -n argocd + +# Sync specific app +argocd app sync astroshop-productcatalog-dev + +# Check application status +argocd app get astroshop-productcatalog-prod + +# View pod logs +kubectl logs -n astroshop-dev -l app=productcatalog -f + +# Port forward to services +kubectl port-forward -n astroshop-dev svc/<service-name> 8080:8080 +``` + +## 📝 License + +MIT License - This is an educational project based on the OpenTelemetry Demo. + +## 🙏 Acknowledgments + +- [OpenTelemetry Demo](https://github.com/open-telemetry/opentelemetry-demo) team for the excellent microservices demo +- OpenTelemetry, ArgoCD, Kubernetes, and Terraform communities |