Quick Start

Installing Orion is meant to be as easy as possible. We provide a "OneClick" installer which will allow you to install Orion as fast as possible for both local testing and enterprise deployments.

Pre-requisites (Test/Dev)

1. Our deployment can run on any relatively modern Linux distribution with systemd support.

   Details

   In case you'd like to validate the specifics, check out:

   • k3s System Requirements
   • Ensure modprobe wireguard runs correctly - this is used to secure the cross-node traffic and comes by default on modern Linux kernels
   • Ensure cgroupv2 support (already there on all modern Linux releases)

2. The DNS name for your Orion installation points at the IP of the first node in the cluster.

   • For community contributors or small test deployments, this can be just the IP.
   • Large production deployments, we recommend you make this a CNAME record, such as orion.yourdomain.com.

3. As a bare minimum, you will need a single node meeting the "service node" requirements listed in our System Requirements

4. (Optional) When performing an air-gapped installation, ensure that:

   • you meet all Pre-requisites listed in our air-gapped installation guide
   • you have downloaded the latest Installer Archive tar.gz archive and placed it on the first node of your Orion cluster.
     • you will be prompted for the filepath to the installer
     • once that node is up, you'll be able to join the remaining ones using the Genesis web UI.

Installation - bootstrapping the cluster

1. Connect to one of the servers you allocated for the service/control-plane node via SSH.

   ssh user@your-server-ip
   

2. Run our helper script to set up the environment and download the latest OneClick Installer.

   curl -sL "$(curl -s https://api.github.com/repos/juno-fx/Juno-Bootstrap/releases/latest | grep browser_download_url | grep orion-install-helper | cut -d '"' -f 4)" | bash -
   

3. Fill out the form and select "On Prem K3s" as the Deployment Target and follow the prompts.

Production Deployments

While this is the quickest way to get started, for production deployments we recommend you configure the created cluster using our System Requirements as a guide. The generated cluster is a great starting point and already handles quite a few of the labeling steps for you.

Joining more nodes to the cluster

Once your cluster is up, you can easily expand it through the web UI. Check out the documentation for it here

Uninstall

1. Connect to your server via SSH.

   ssh user@your-server-ip
   

2. To uninstall k3s (including Orion), run the following command on the server where it was installed:

   # control nodes
   sudo k3s-uninstall.sh
   
   # worker nodes
   sudo k3s-agent-uninstall.sh
   

Next Steps

Now that the cluster is running, we recommend you explore the following steps.

1. Authentication Guide
2. License Management Guide
3. Expand your Orion Cluster
4. Explore Genesis - the management platform for Orion
5. Explore Hubble - the namespace portal for deployed Orion projects
6. Explore Terra - the plugin driven deployment platform for Orion

Additional Deployment Options

The OneClick installer supports multiple deployment targets:

• On-Premises using k3s - a lightweight Kubernetes distribution perfect for small clusters and edge deployments.
• AWS EKS (Coming Soon) - EKS deployment target for enterprise AWS customers.
• CoreWeave (Coming Soon) - CoreWeave deployment target for enterprise CoreWeave customers.

We've successfully tested Orion on multiple Kubernetes distributions:

• Local Development: Development teams use kind clusters to run Juno.
• Cloud: Our internal production Juno Cloud runs on Amazon EKS
• On-Premises: Test environments operate on k3s with hybrid architectures

Multi-Architecture Support

All deployments support both Arm64 and x86_64 architectures, allowing you to choose the best hardware for your needs.