mirror of
https://github.com/mulgadc/spinifex.git
synced 2026-10-19 10:52:04 +00:00
Ben Duncan
704874c0c7
All 3 install guides (binary, multi-node, source) now end at the same verification point: aws ec2 describe-instance-types. Installation is complete when that command returns instance types. New docs/setting-up-your-cluster/README.md is the common guide all 3 install paths point to. Covers: AMI import, SSH key creation, VPC with public subnet (IGW + modify-subnet-attribute), instance launch with public IP, SSH via public IP, instance lifecycle management. Removed SSH-via-hostfwd from all guides — public subnet is the default connectivity path. Private subnet documented as an alternative.
title, description, category, tags, badge, resources
| title | description | category | tags | badge | resources | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Source Install | Build Spinifex from source for development, custom builds, or contributing. | Getting Started |
|
source |
|
Source Install
Build Spinifex from source for development, custom builds, or contributing.
Table of Contents
Overview
This guide builds Spinifex from source. For production deployments, the binary installer is recommended.
Requirements:
- Ubuntu 22.04+ / Debian 12+
- Go 1.26.1+
- GCC, make, pkg-config
- QEMU/KVM, OVN/Open vSwitch, AWS CLI v2
Instructions
Step 1. Install dependencies
mkdir -p ~/Development/mulga && cd ~/Development/mulga
git clone https://github.com/mulgadc/spinifex.git
sudo make -C spinifex quickinstall
export PATH=$PATH:/usr/local/go/bin
Step 2. Clone and build
cd spinifex
./scripts/clone-deps.sh
./scripts/dev-setup.sh
Confirm ./bin/spx exists.
Step 3. Initialize
./bin/spx admin init --region ap-southeast-2 --az ap-southeast-2a --node node1 --nodes 1
Save the admin credentials printed during init.
Step 4. Trust the CA certificate
sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates
Step 5. Setup OVN
./scripts/setup-ovn.sh --management --external-bridge --external-iface=enp0s3 --dhcp
Replace enp0s3 with your WAN interface. Single-NIC hosts should add --single-nic.
Step 6. Start services
./scripts/start-dev.sh
export AWS_PROFILE=spinifex
Step 7. Verify
aws ec2 describe-instance-types
If this returns a list of available instance types, your installation is working.
Congratulations! Spinifex is installed from source.
Continue to Setting Up Your Cluster to import an AMI, create a VPC, and launch your first instance.
Troubleshooting
Go not found in PATH
export PATH=$PATH:/usr/local/go/bin
./bin/spx missing after build
./scripts/dev-setup.sh
CA certificate not trusted
sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates