CNCF Projects App
Overview
Have you ever wondered what an application architecture would look like if you committed to using mostly all graduated or incubating projects from the Cloud Native Computing Foundation? This repo, the CNCF Projects App, attempts to answer that question with an example expense application that is made up almost exclusively of CNCF projects.
CNCF Projects Application
The CNCF Projects App is a sample expense application simulating a user submitting an expense report. The application consists of the following components:
- Kubernetes - Container Orchestration Cluster (CNCF)
- Flux. CNCF. GitOps provider for infrastructure delivery (CNCF).
- Rook - Storage Management (CNCF)
- Harbor - Container Registry (CNCF)
- Linkerd - Service Mesh (CNCF)
- Prometheus - Monitoring (CNCF)
- Jaeger - Observability/Tracing (CNCF)
- Knative - Serverless (CNCF)
- MySQL - Database
- Nginx - Kubernetes Ingress Controller
- Tekton CI/CD (CD Foundation)
- Grafana - Dashboard
- SendGrid - Email Service
- GitHub - Code Repository
- Web Front-End & Web API - .NET Core
Architecture
Below is the documented CNCF Projects App architecture for reference.
Workflow
Application flow
1. The employee accesses a web app via NGINX Ingress to submit expenses.
2. The web app calls an API app to retrieve the employee's manager.
3. The web app pushes a message that's generated for the creation of the expense report to a Knative broker.
4. The expense report is saved in MySQL.
5. Knative triggers the Email Dispatcher function with the expense message as the payload.
6. Email Dispatcher creates a SendGrid message.
7. SendGrid sends an email to the retrieved manager for review.
DevOps flow
a. Developers write or update the code in Visual Studio Code.
b. Developers push the code to GitHub from their local workspace in Visual Studio Code.
c. Github Webhook triggers Tekton pipelines which clones the GitHub code.
d. Pipelines build and push and the container images to a Harbor registry.
e. Tekton deploys the web app, API app, and Email Dispatcher applications.
f. Prometheus captures application metrics.
g. Engineers monitor metrics on a Grafana Dashboard.
h. DevOps engineers monitor the Grafana Dashboard.
Infrastructure
i. AKS cluster based on the infrastructure presented in the AKS baseline.
ii. Rook Ceph used for cluster storage.
iii. Linkerd service mesh.
iv. Jaeger for overall application tracing on the Kubernetes cluster.
Install
Please follow the instructions here in sequence to deploy the CNCF Projects App in your environment.
Instructions for automated deployment through gitops are here.
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.