Quick Installation Guide

This is a quick guide for you to install a full-fledged single-node Cordium Cluster on any cheap Linux machine, VM or cloud VPS (e.g. DigitalOcean droplet, Hetzner, AWS EC2, etc...). This single-node Cluster is good enough for development, personal, or undemanding production use cases.

note

To install a production, scalable multi-node Cluster over a typical cloud-based or on-premise Kubernetes installation, we recommend referring to this guide here.

Fresh Installation

This guide uses the exact same steps and exact same installer script used for the Octelium Cluster quick installation guide as it installs an Octelium Cluster, and then it automatically installs the Cordium package at the end via the --cordium flag. To install the Cordium Cluster, simply SSH into your VPS/VM as the Linux root user and install the Cluster by running the following commands:

curl -o install-cluster.sh https://octelium.com/install-cluster.sh
chmod +x install-cluster.sh

# IMPORTANT: Replace <DOMAIN> with your actual domain/subdomain to be used as the Cluster domain
./install-cluster.sh --domain <DOMAIN> --cordium

The script should take a few minutes depending on your VM's capabilities to finish.

note

It's absolutely recommended to read the Octelium Cluster quick installation guide to understand how to install and initialize the Cluster correctly.

Installation on an Existing Octelium Cluster

If you already have a running Octelium Cluster that was installed via the quick installation guide, you only need to label the Kubernetes node as follows:

# This is the kubeconfig path inside the k3s cluster machine
export KUBECONFIG="/etc/rancher/k3s/k3s.yaml"

kubectl label nodes --all octelium.com/node-mode-cordium=

And then install the Cordium package as follows:

octops install-package <DOMAIN> --package cordium
# Or with an explicit kubeconfig path
octops install-package <DOMAIN> --package cordium --kubeconfig /path/to/kueconfig

What Now?

Once you authenticate to the Cluster via the octelium login command shown to you at the end of the Cluster installation, you can now simply run your first Workspace as follows:

cordium run

You can also visit the Cordium web portal via your web browser at https://cordium.<DOMAIN> and run Workspaces and terminals from there.