https://github.com/cortexflow/cortexbrain
CortexBrain is an ambitious open source project aimed at creating an intelligent, lightweight, and efficient service mesh architecture to seamlessly connect cloud and edge devices
https://github.com/cortexflow/cortexbrain
big-data data-science devops docker edge-computing in-development k8s kubernetes machine-learning microservices-architecture open-source rust rust-lang service-mesh
Last synced: 10 months ago
JSON representation
CortexBrain is an ambitious open source project aimed at creating an intelligent, lightweight, and efficient service mesh architecture to seamlessly connect cloud and edge devices
- Host: GitHub
- URL: https://github.com/cortexflow/cortexbrain
- Owner: CortexFlow
- License: apache-2.0
- Created: 2024-08-22T07:44:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-08T20:53:48.000Z (10 months ago)
- Last Synced: 2025-04-08T21:33:23.358Z (10 months ago)
- Topics: big-data, data-science, devops, docker, edge-computing, in-development, k8s, kubernetes, machine-learning, microservices-architecture, open-source, rust, rust-lang, service-mesh
- Language: Rust
- Homepage: https://www.cortexflow.org
- Size: 38.4 MB
- Stars: 31
- Watchers: 2
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# CortexBrain © 2025
[](https://github.com/CortexFlow/CortexBrain/releases)
[](./LICENSE)
[](https://www.cortexflow.org/doc/)
[](https://trello.com/invite/b/66c731aab6030598aef7aed3/ATTIdfd7d08e42dca6f8b56a8b26f499ab8c95EB547E/cortexbrain)
[](https://www.docker.com)
[](https://kubernetes.io)
[](https://github.com/CortexFlow/CortexBrain/discussions)
[](https://github.com/CortexFlow/CortexBrain#contributing)
[](https://dev.to/cortexflow)
## 📬Contacts
- **Tettamanti Lorenzo** [📧 lorenzotettamanti5@gmail.com](mailto:lorenzotettamanti5@gmail.com)
- **Lorenzo Bradanini** [📧 lorenzolollobrada@gmail.com](mailto:lorenzolollobrada@gmail.com)
# 🧑💻What is CortexBrain?
**CortexBrain** is an ambitious open source project aimed at creating an intelligent, lightweight, and efficient architecture to seamlessly connect cloud and edge devices.
# ⚛️ **Current Development Focus**
Our current development efforts are dedicated to the following key improvements:
- 🔧 **System Architecture:** Optimizing the actual [architecture](https://www.cortexflow.org/doc/#architecture) by eliminating sidecar proxies while maintaining scalability
- 🌐 **Kernel-Level Observability with eBPF:** Enhancing system observability by leveraging eBPF to collect logs,metrics at the kernel level
- 📊 **Expanded Metrics:** Extending the current [metrics](https://www.cortexflow.org/doc/#detected-metrics) landscape to provide deeper understanding
- 🖥️ **Integrating a Command Line Interface:** We're actually working on a CLI to let users interact with the cluster without any stress or frustation. You can track the progress of the CLI tool by referring to the [Milestone]
- 📡 **Cloud-Edge Multi-Cluster Integration:** Enabling orchestration between cloud environments and edge devices
# 🤖 Getting Started
CortexBrain is still in its development stages, so you can expect some bugs. Contributions and feedback are highly appreciated to help improve the project! 🚀
Below there's a guide to get started
## 🥷 Installation
To get started with CortexBrain, follow these steps:
- **Clone the Repository**: First, clone the repository to your local machine.
```bash
git clone https://github.com/CortexFlow/CortexBrain.git
```
- **Install required packages**:
| **Feature** | **Requirements** |
| ------------------------- | -------------------------------------------------------------------------------- |
| **CortexBrain Core** | - Kubernetes or Minikube v1.34.0
- Linux Ubuntu system (preferred for development)
- Rust programming language (rustc >= 1.83.0)|
| **CortexBrain Dashboard** | - npm v10.7.0
- React v18.2.0
- Electron v33.2.0 |
- ## **Core Development:**
1. Install Rust using RustUp tools :
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
2. Install [Docker](https://www.docker.com/get-started/)
3. Install [Minikube](https://minikube.sigs.k8s.io/docs/start/?arch=%2Fwindows%2Fx86-64%2Fstable%2F.exe+download)
4. Run minikube
```bash
minikube start
```
5. Run the installation script:
```bash
cd Scripts
./install.sh
```
- ## **Dashboard Development:**
1. Install [Node.js](https://nodejs.org/en/download)
2. Open the dashboard folder and install the required packages
```bash
cd dashboard
npm install
```
3. Run the local development server
```bash
npm start
```
# 💪🏻 Contributing
Do you think the project is missing something? Contributing is the best way to show your skills and leave your mark in a project
If you have knowledge in DevOps/Kubernetes or Networks please write an email to lorenzotettamanti5@gmail.com
| **Role** | **Skills** | **Tasks** | **Related Issues and Milestones** |
| ------------------------- | ------------------------------------------------------------------------- | --------------- |--------|
| **CortexBrain Core Developer** | - Kubernetes
- Networks
- Rust programming language | - Work alongside us to build and optimize the core functionalities (Client,DNS,Proxy,Telemetry,etc..)
| - [Rust](https://github.com/CortexFlow/CortexBrain/labels/rust)
- [Core](https://github.com/CortexFlow/CortexBrain/milestone/1)
| **CortexBrain Dashboard Developer** | - React
- Frontend Development
- Javascript/TypeScript | - Work alongside us to design and improve the dashboard
| [Javascript](https://github.com/CortexFlow/CortexBrain/labels/javascript)
| **General Mantainers** | - Github
- Practical organition
- Documentation | - Keep the repository organized and clean
- Write/Update documentation
- Spot typos in the repository | - [Documentation](https://github.com/CortexFlow/CortexBrain/labels/documentation)
- [question](https://github.com/CortexFlow/CortexBrain/labels/question)
| **Code Reviewers/Testers** | - Rust
- Javascript/TypeScript
- Kubernetes
- Docker | - Review code and suggest changes/optimizations
- Write tests for CI/CD | [Code refactoring](https://github.com/CortexFlow/CortexBrain/labels/code%20refactoring)
## 🤖 How to Contribute?
We welcome contributions from the community! To contribute to the project, please follow these steps:
1. Fork the repository.
2. Check out [Contributing Best Practices](https://github.com/CortexFlow/CortexBrain/blob/main/CONTRIBUTING.md)
3. Create a new branch for your feature (`git checkout -b feature/feature-name`).
4. Submit a Pull Request with a detailed explanation of your changes.
## 🙋**Proposing New Features**
If you would like to contribute a new feature, we ask you to open a discussion before submitting a PR. This is to ensure that all new features align with the project's goals and to avoid overlapping work or conflicting views.
Please initiate a discussion in the [GitHub Discussions](https://github.com/CortexFlow/CortexBrain/discussions) section where we can collectively review, refine, and approve your idea before you begin implementation. Pull Requests for new features that have not been discussed beforehand may be declined to maintain project coherence and ensure alignment with the broader roadmap.
By collaborating in this manner, we can maintain clarity and consistency, ensuring that all contributors are working towards the same objectives. Thank you for your understanding and contributions!
## 🐐 Top contributors
[](https://github.com/CortexFlow/CortexBrain/graphs/contributors)