https://github.com/oakestra/oakestra
A Lightweight Hierarchical Orchestration Framework for Edge Computing
https://github.com/oakestra/oakestra
docker edge-computing orchestration
Last synced: 5 months ago
JSON representation
A Lightweight Hierarchical Orchestration Framework for Edge Computing
- Host: GitHub
- URL: https://github.com/oakestra/oakestra
- Owner: oakestra
- License: apache-2.0
- Created: 2021-04-23T17:39:24.000Z (about 5 years ago)
- Default Branch: develop
- Last Pushed: 2026-01-16T12:28:36.000Z (5 months ago)
- Last Synced: 2026-01-17T02:46:59.054Z (5 months ago)
- Topics: docker, edge-computing, orchestration
- Language: Python
- Homepage: https://oakestra.io
- Size: 918 MB
- Stars: 72
- Watchers: 2
- Forks: 31
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/oakestra/oakestra/tree/v0.4.400)
[]()
**Oakestra** is an orchestration platform designed for Edge Computing.
Popular orchestration platforms such as Kubernetes or K3s struggle at maintaining workloads across heterogeneous and constrained devices.
Oakestra is build from the ground up to support computation in a flexible way at the edge.
🌐 Read more about the project at: [oakestra.io](http://oakestra.io)
📚 Check out the project wiki at: [oakestra.io/docs](https://www.oakestra.io/docs/getting-started/welcome-to-oakestra-docs/)
---
### Minimum System Requirements
Root and Cluster orchestrator (combined):
- Docker + Docker Compose v2
- 5GB of Disk
- 1GB of RAM
- ARM64 or AMD64 architecture
Worker Node:
- Linux based distro with iptables compatbiliety
- 50MB of space
- 100MB RAM
- ARM64 or AMD64 architecture
### Network Configuration
Root:
- External APIs: port 10000
- Cluster APIs: ports 10099,10000
Cluster:
- Worker's Broker: port 10003
- Worker's APIs: port 10100
Worker:
- P2P tunnel towards other workers: port 50103
Before being able to deploy your first application, we must create a fully functional Oakestra Root 👑, to that we attach the clusters 🪵, and to each cluster we attach at least one worker node 🍃.
Check out the [GetStarted Guide](https://www.oakestra.io/docs/getting-started/oak-environment/create-your-first-oakestra-orchestrator/).
# ⚒️ Build Instructions
### Root Orchestrator
Build and run your own Root Orchestrator
On a Linux machine first, install Docker and Docker compose v2.
Configure the address used by the dashboard to reach your APIs by running:
`export SYSTEM_MANAGER_URL=
`
Then clone the repo and run:
```bash
cd root_orchestrator/
docker-compose up --build
```
The following ports are exposed:
- Port 80/TCP - Dashboard
- Port 10000/TCP - System Manager (It also needs to be accessible from the Cluster Orchestrator)
- Port 50052/TCP - System Manager (Needs to be exposed to the Clusters for cluster registration.)
- Port 10099/TCP - Service Manager (This port can be exposed only to the Clusters)
### Cluster Orchestrator
For each cluster, we need at least a machine running the clsuter orchestrator.
- Log into the target machine/vm you intend to use
- Install Docker and Docker compose v2.
- Export the required parameters:
```bash
## Choose a unique name for your cluster
export CLUSTER_NAME=My_Awesome_Cluster
## Optional: Give a name or geo coordinates to the current location. Default location set to coordinates of your IP
#export CLUSTER_LOCATION=My_Awesome_Apartment
## IP address where this root component can be reached to access the APIs
export SYSTEM_MANAGER_URL=
# Note: Use a non-loopback interface IP (e.g. any of your real interfaces that have internet access).
# "0.0.0.0" leads to server issues
```
If you wish yo build the cluster orchestrator yourself simply clone the repo and run:
```bash
export CLUSTER_LOCATION=My_Awesome_Apartment #If building the code this is not optional anymore
cd cluster_orchestrator/
docker-compose up --build
```
The following ports must be exposed:
- 10100 Cluster Manager (needs to be accessible by the Node Engine)
### Worker nodes
#### Worker nodes - Build your node engine
*Requirements*
- Linux OS with the following packages installed (Ubuntu and many other distributions natively supports them)
- iptable
- ip utils
- port 50103 available to all worker nodes
Compile and install the binary with:
```
cd go_node_engine/build
./build.sh
./install.sh $(dpkg --print-architecture)
```
Then configure and install the [NetManager](github.com/oakestra/oakestra-net) and perform the startup as usual.