diff --git a/README.md b/README.md new file mode 100644 index 0000000..a5c76ba --- /dev/null +++ b/README.md @@ -0,0 +1,139 @@ +# 🧩 Agentless Proxy App + +[![Issues](https://img.shields.io/github/issues/service-mesh-patterns/agentless-proxy-app)](https://github.com/service-mesh-patterns/agentless-proxy-app/issues) +[![Pull Requests](https://img.shields.io/github/issues-pr/service-mesh-patterns/agentless-proxy-app)](https://github.com/service-mesh-patterns/agentless-proxy-app/pulls) +[![Last Commit](https://img.shields.io/github/last-commit/service-mesh-patterns/agentless-proxy-app)](https://github.com/service-mesh-patterns/agentless-proxy-app/commits) +[![License](https://img.shields.io/github/license/service-mesh-patterns/agentless-proxy-app)](LICENSE) + +A lightweight demo application to showcase agentless service mesh patterns under the Service Mesh Patterns initiative. πŸš€ + +--- + +## ✨ Overview + +The **Agentless Proxy App** is a microservice designed to demonstrate and test sidecarless service mesh architectures. It provides a practical way to explore service mesh capabilities without the overhead of sidecar proxies. + +### πŸ” What it does: +- Showcases traffic flow in a sidecarless service mesh +- Validates routing, observability, and security features +- Simulates service communication for mesh compatibility testing + +--- + +## πŸ“Έ Architecture Preview + +> _Service Mesh Diagram Placeholder_ +We welcome contributions to enhance or update this diagram! ✨ + +--- + +## πŸš€ Getting Started + +### βœ… Prerequisites + +Ensure the following tools are installed on your machine: +- Docker 🐳 +- Kubernetes ☸️ +- kubectl πŸ› οΈ + +### πŸ›  Installation + +```bash +# Clone the repository +git clone https://github.com/service-mesh-patterns/agentless-proxy-app.git +cd agentless-proxy-app + +# Deploy to Kubernetes +kubectl apply -f manifests/deployment.yaml + +# Access the application +kubectl port-forward svc/agentless-proxy-app 8080:80 +``` + +## πŸ”§ Tech Stack + +Depending on the version/branch, this app can be implemented in: + +- Python 🐍 +- Node.js πŸ“¦ +- Go 🐹 + +--- + +## 🀝 Contributing + +We ❀️ contributions from the community! Whether you're fixing a bug, adding a feature, or improving documentation β€” your help is welcome. + +### πŸͺ„ How to Contribute + +```bash +1. 🍴 Fork this repository +2. 🌿 Create a new feature branch: git checkout -b feature/awesome-feature +3. πŸ’Ύ Commit your changes: git commit -m "Add awesome feature" +4. πŸš€ Push to the branch: git push origin feature/awesome-feature +5. πŸ“¬ Open a Pull Request + +``` + +## πŸ“Œ New to open source? +Check out the [Layer5 Contributor Guide](https://layer5.io/community/handbook). + +--- + +## πŸ§ͺ Sample Manifest + +Below is a sample Kubernetes Deployment manifest for the app: + +```yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: agentless-proxy-app +spec: + replicas: 1 + selector: + matchLabels: + app: agentless-proxy-app + template: + metadata: + labels: + app: agentless-proxy-app + spec: + containers: + - name: app + image: your-image-name + ports: + - containerPort: 80 +``` + +πŸ’‘ Want more manifests (e.g., `Service`, `Ingress`)? Let us know and we’ll add them! + +--- + +## πŸ“„ License + +This project is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). + +--- + +## 🌐 Community & Support + +Join the Layer5 Community to connect with contributors, ask questions, and explore more cloud native tools: + +- πŸ› [Report bugs or suggest features](https://github.com/service-mesh-patterns/agentless-proxy-app/issues) +- πŸ’¬ [Chat with us on Layer5 Slack](https://layer5.io/slack) +- πŸ“š [Explore more Service Mesh Patterns](https://github.com/service-mesh-patterns) + +--- + +## 🎨 Want More? + +We’re happy to add: + +- πŸ”½ Collapsible sections for readability +- πŸ“¦ More deployment manifests (e.g., Service, Ingress) +- πŸ‘₯ Contributor or sponsor sections +- πŸ–Ό Architecture diagrams or Figma links + +Let us know how you’d like to enhance this README! 🌟 +