Initial cloud-services repo - gateway service + pkg modules
This commit is contained in:
49
README.md
Normal file
49
README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# cloud-services
|
||||
|
||||
Go microservices for the vehicle cloud platform.
|
||||
|
||||
## Quick Start
|
||||
```bash
|
||||
# Install devbox (if needed)
|
||||
curl -fsSL https://get.jetify.com/devbox | bash
|
||||
|
||||
# Enter dev environment
|
||||
devbox shell
|
||||
|
||||
# Run a service locally
|
||||
cd services/gateway
|
||||
go run .
|
||||
```
|
||||
|
||||
## Structure
|
||||
```
|
||||
services/ # Individual Go microservices
|
||||
shared/ # Shared Go modules
|
||||
deploy/ # Kubernetes manifests (kustomize)
|
||||
base/ # Base configs
|
||||
overlays/ # Environment-specific (development, etc.)
|
||||
```
|
||||
|
||||
## Services
|
||||
| Service | Description |
|
||||
|---------|-------------|
|
||||
| gateway | API gateway, routes requests |
|
||||
| auth | Authentication (Keycloak integration) |
|
||||
| ota | OTA update management |
|
||||
| depot | Vehicle registration & management |
|
||||
| attendant | Event processing |
|
||||
| cargo | Data ingestion to storage |
|
||||
| ditto | Digital twin state |
|
||||
| manufacture | Manufacturing integration |
|
||||
| aftersales | Aftersales/diagnostic services |
|
||||
|
||||
## Local Development
|
||||
Services connect to:
|
||||
- PostgreSQL: `cloud-dev-rw.cnpg-system.svc:5432`
|
||||
- MongoDB: `cloud-dev-svc.mongodb.svc:27017`
|
||||
- Redis: `cloud-dev.redis.svc:6379`
|
||||
- Kafka: `cloud-dev-kafka-bootstrap.kafka.svc:9092`
|
||||
- Keycloak: `https://keycloak.mini.cloud.fiskerinc.com`
|
||||
|
||||
## Deployment
|
||||
ArgoCD syncs from this repo. Push to main → auto-deploy to mini cluster.
|
||||
Reference in New Issue
Block a user