⚠ This page documents a version of Oakestra which is not the latest stable. Please refer to the latest docs for a current version.
Create a Single-Node Cluster
Let’s get you up to speed with the easiest possible setup. You’ll be able to run your first Oakestra orchestrator in a few seconds, all on a single device!
In this guide, we’ll perform a single-machine setup. This setup is the easiest way to get started with Oakestra, with a single cluster managed by a single machine. To do so, we’ll install the Root Orchestrator, the Cluster Orchestrator, and the Worker Node together, as shown in the following figure.
You can install the Root and Cluster Orchestrator on a single machine using the following commands:
Install the oak CLI on your machine:
curl -sfL oakestra.io/oak.sh | bash
Perform a full Root + Cluster + Worker installation using:
oak install full alpha-v0.4.410
That’s it! You should be good to go now.
Take a look at the example below.
The installer asks whether to start your worker right away.
If you choose not to start it immediately, you can do so later using:
oak worker -d
Did you know?
You can set up a multi-cluster infrastructure by installing each Cluster Orchestrator and Worker Node on a different machine.
Check out the Advanced Oakestra Clusters Setup section for more details.
Network Configuration
If you run into a restricted network (e.g., on a cloud VM), you need to configure the firewall rules and the NetManager component accordingly. Please refer to: Firewall Setup
If the installation command succeeded, you can now check if your cluster is showing up correctly using the command:
oak cluster ls
If your cluster is showing up with one active node, congratulations! 🎉🎉
If not, wait a few minutes; the cluster startup might take a while. If still nothing happens, you can refer to the Troubleshooting Guide.
