Update README.md and add Copilot instructions for EntKube
Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
48
README.md
48
README.md
@@ -1,2 +1,48 @@
|
||||
# Entkube
|
||||
# EntKube
|
||||
|
||||
A multi-tenant platform for managing shared Kubernetes applications and infrastructure services.
|
||||
|
||||
## Vision
|
||||
|
||||
EntKube provides a unified developer portal for provisioning, configuring, and monitoring shared services running on Kubernetes — such as MinIO, CloudNativePG, Keycloak, and more. Teams get self-service access to the infrastructure they need without managing the underlying clusters directly.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Shared Application Management** — Deploy, configure, and lifecycle-manage shared services (MinIO, CNPG, Keycloak, etc.) across clusters.
|
||||
- **Multi-Tenant SaaS** — Isolated tenants with role-based access, resource quotas, and per-team service instances.
|
||||
- **Kubernetes Cluster Management** — Register, monitor, and operate multiple clusters from a single control plane.
|
||||
- **Infrastructure Monitoring & Observability** — Health dashboards, alerts, and resource usage metrics for managed services.
|
||||
- **Developer Portal** — Self-service UI for teams to request and manage their service instances.
|
||||
- **CI/CD Pipeline Integration** — Trigger deployments, view pipeline status, and promote releases across environments.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
| Layer | Technology |
|
||||
|-------|-----------|
|
||||
| Frontend | Blazor (.NET 10) — Server + WebAssembly |
|
||||
| Backend | ASP.NET Core 10 |
|
||||
| Auth | ASP.NET Core Identity with passkey support |
|
||||
| Database | SQLite (dev) / PostgreSQL (prod) |
|
||||
| ORM | Entity Framework Core 10 |
|
||||
|
||||
## Getting Started
|
||||
|
||||
```bash
|
||||
cd EntKube/EntKube
|
||||
dotnet run
|
||||
```
|
||||
|
||||
The app launches at `https://localhost:7001` (see `Properties/launchSettings.json`).
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
EntKube/
|
||||
├── EntKube/ # Server-side Blazor host, Identity, data layer
|
||||
└── EntKube.Client/ # WebAssembly client project
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
See [LICENSE](LICENSE).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user