Update README.md to provide a comprehensive overview of The Order monorepo, including repository structure, quickstart guide, development workflow, and contribution guidelines.
This commit is contained in:
58
infra/README.md
Normal file
58
infra/README.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# Infrastructure
|
||||
|
||||
Infrastructure as code for The Order.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
- `terraform/` - Terraform configurations
|
||||
- `k8s/` - Kubernetes manifests and Helm charts
|
||||
- `gateways/` - API gateway and proxy configurations
|
||||
- `cicd/` - CI/CD templates and scripts
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. **Terraform**: Set up cloud infrastructure
|
||||
```bash
|
||||
cd terraform
|
||||
terraform init
|
||||
terraform plan
|
||||
terraform apply
|
||||
```
|
||||
|
||||
2. **Kubernetes**: Deploy applications
|
||||
```bash
|
||||
cd k8s
|
||||
kubectl apply -k overlays/dev
|
||||
```
|
||||
|
||||
3. **Gateway**: Configure API gateway
|
||||
```bash
|
||||
cd gateways
|
||||
# Apply gateway configuration
|
||||
```
|
||||
|
||||
## Environments
|
||||
|
||||
- **Development**: Local development environment
|
||||
- **Staging**: Pre-production environment
|
||||
- **Production**: Live production environment
|
||||
|
||||
## Security
|
||||
|
||||
- Secrets management via SOPS and KMS
|
||||
- Network policies and security groups
|
||||
- WAF rules for API protection
|
||||
- TLS/SSL certificates
|
||||
- Regular security audits
|
||||
|
||||
## Monitoring
|
||||
|
||||
- Prometheus for metrics
|
||||
- Grafana for dashboards
|
||||
- OpenTelemetry for tracing
|
||||
- ELK/OpenSearch for logging
|
||||
|
||||
## Documentation
|
||||
|
||||
See individual README files in each subdirectory for more details.
|
||||
|
||||
Reference in New Issue
Block a user