75 lines
2.0 KiB
Markdown
75 lines
2.0 KiB
Markdown
# 🌐 Elixier Management Tool
|
|
|
|
A web app tool to **deploy and manage data platform clusters on Kubernetes**.
|
|
|
|
This web app provides a unified interface for managing tenants, clusters, and users, and integrates with key services such as **Superset**, **Airflow** and **Trino**.
|
|
|
|
---
|
|
|
|
## 🚀 Quick Links
|
|
|
|
- 🏗️ [Architecture Overview](docs/architecture-overview.md)
|
|
- 👥 [User Manual](docs/user-manual.md)
|
|
- 📘 [Data Platform Manual](docs/data-platform-manual.md)
|
|
- 🧰 [Developers Guide](docs/developers-guide.md)
|
|
- 🛠️ [Installation Guide](docs/installation-guide.md)
|
|
|
|
---
|
|
|
|
## 📑 Table of Contents
|
|
|
|
- [System Components](#-system-components)
|
|
- [Key Features](#-key-features)
|
|
- [License](#-license)
|
|
- [Contact](#-contact)
|
|
|
|
---
|
|
|
|
## ⚙️ System Components
|
|
|
|
| Component | Description |
|
|
|------------|--------------|
|
|
| **Frontend** | Web interface running NextJS app that are built by Reflex. |
|
|
| **Backend** | FastAPI backend as part of Reflex framework. |
|
|
| **PostgreSQL** | Primary database for application metadata and user management. |
|
|
| **Valkey** | In-memory cache for sessions and task queues. |
|
|
| **OpenSearch** | Store logs of hosts, clusters, service deployments and users audit. |
|
|
| **Agent** | Installed on each host to handle communication with the central web app. |
|
|
|
|
---
|
|
|
|
## 🧩 Key Features
|
|
|
|
- Multi-tenant & multi-cluster management
|
|
- Host and cluster lifecycle control
|
|
- User and role-based access management
|
|
- Integrated SSO authentication
|
|
- Service links and status dashboards
|
|
- Extensible architecture for new components
|
|
|
|
---
|
|
|
|
## Other docs
|
|
|
|
- [DB Schema](docs/db-schema.md)
|
|
- [Development Guide (old)](docs/development.md)
|
|
- [Installation using Docker](docs/docker.md)
|
|
- [Get Started (old)](docs/get-started.md)
|
|
- [Software Requirement Specification (SRS)](docs/srs.md)
|
|
- [Test Procedure Specification (TPS)](docs/test-procedure-spec.md)
|
|
|
|
---
|
|
|
|
## 📜 License
|
|
|
|
TBD
|
|
|
|
---
|
|
|
|
## 📬 Contact
|
|
|
|
**Project Maintainers**
|
|
Abyres Sdn. Bhd. — DevOps / Platform Engineering Team
|
|
📧 support@abyres.net
|
|
🌐 [Company Website](https://www.abyres.net)
|