gsadmin/spinifex
1
0
Fork 0
mirror of https://github.com/mulgadc/spinifex.git synced 2026-10-21 03:36:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update install guides + setup.sh for new setup-ovn.sh flags

Browse Source 
- All guides: OVN setup before admin init (consistent ordering)
- Single-node + source-install: Replace --external-bridge/--external-iface
  with auto-detection + --wan-bridge/--wan-iface/--macvlan options
- Multi-node: Simplify examples (auto-detect WAN bridge), show override
  options in prose
- setup.sh: Update "next steps" to match single-node guide, add
  --wan-bridge/--macvlan guidance for physical NIC setups

Part of mulga-742.
This commit is contained in:
Ben Duncan
2026-03-24 16:17:35 +10:00
parent 8c6f66670a
commit 78bc0d989d
4 changed files with 36 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/installing-spinifex-multi-node/README.md
+1 -6
View File
@@ -60,14 +60,13 @@ export AWS_AZ=us-east-1a
### Step 3. Setup OVN networking
Server 1 runs OVN central and must be set up first.
Server 1 runs OVN central and must be set up first. If your WAN interface is already a bridge (e.g. `br-wan`), setup-ovn.sh auto-detects it. Otherwise use `--wan-bridge=br-wan --wan-iface=eth1` (dedicated WAN NIC) or `--macvlan --wan-iface=eth0` (single-NIC).
**Server 1:**
```bash
sudo /usr/local/share/spinifex/setup-ovn.sh \
--management \
--external-bridge --external-iface=eth1 --dhcp \
--encap-ip=$SPINIFEX_NODE1
```
@@ -75,7 +74,6 @@ sudo /usr/local/share/spinifex/setup-ovn.sh \
```bash
sudo /usr/local/share/spinifex/setup-ovn.sh \
--external-bridge --external-iface=eth1 --dhcp \
--ovn-remote=tcp:$SPINIFEX_NODE1:6642 \
--encap-ip=$SPINIFEX_NODE2
```
@@ -84,13 +82,10 @@ sudo /usr/local/share/spinifex/setup-ovn.sh \
```bash
sudo /usr/local/share/spinifex/setup-ovn.sh \
--external-bridge --external-iface=eth1 --dhcp \
--ovn-remote=tcp:$SPINIFEX_NODE1:6642 \
--encap-ip=$SPINIFEX_NODE3
```
Replace `eth1` with your WAN interface.
Verify all 3 chassis registered:
```bash
docs/installing-spinifex/README.md
+20 -10
View File
@@ -58,7 +58,25 @@ curl https://install.mulgadc.com | bash
The installer downloads the Spinifex binary and bootstraps all dependencies (QEMU, OVN/OVS, AWS CLI).
### Step 2. Initialize
### Step 2. Setup OVN networking
If your WAN interface is already a bridge (e.g. `br-wan`), setup-ovn.sh auto-detects it:
```bash
sudo /usr/local/share/spinifex/setup-ovn.sh --management
```
If your WAN is a physical NIC, choose one:
```bash
# Dedicated WAN NIC (not your SSH connection):
sudo /usr/local/share/spinifex/setup-ovn.sh --management --wan-bridge=br-wan --wan-iface=eth1
# Single-NIC host (SSH-safe macvlan):
sudo /usr/local/share/spinifex/setup-ovn.sh --management --macvlan --wan-iface=enp0s3
```
### Step 3. Initialize
```bash
spx admin init --region ap-southeast-2 --az ap-southeast-2a --node node1 --nodes 1
@@ -66,21 +84,13 @@ spx admin init --region ap-southeast-2 --az ap-southeast-2a --node node1 --nodes
This auto-detects your network topology and configures external networking. Save the admin credentials printed during init — they will not be shown again.
### Step 3. Trust the CA certificate
### Step 4. Trust the CA certificate
```bash
sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates
```
### Step 4. Setup OVN networking
```bash
sudo /usr/local/share/spinifex/setup-ovn.sh --management --external-bridge --external-iface=enp0s3 --dhcp
```
Replace `enp0s3` with your WAN interface.
### Step 5. Start services
```bash
docs/source-install/README.md
+12 -2
View File
@@ -75,11 +75,21 @@ sudo update-ca-certificates
### Step 5. Setup OVN
If your WAN interface is already a bridge (e.g. `br-wan`), setup-ovn.sh auto-detects it:
```bash
./scripts/setup-ovn.sh --management --external-bridge --external-iface=enp0s3 --dhcp
./scripts/setup-ovn.sh --management
```
Replace `enp0s3` with your WAN interface.
If your WAN is a physical NIC, choose one:
```bash
# Dedicated WAN NIC (not your SSH connection):
./scripts/setup-ovn.sh --management --wan-bridge=br-wan --wan-iface=eth1
# Single-NIC host (SSH-safe macvlan):
./scripts/setup-ovn.sh --management --macvlan --wan-iface=enp0s3
```
### Step 6. Start services
scripts/setup.sh
+3
View File
@@ -342,6 +342,9 @@ print_summary() {
echo ""
echo " 1. Setup OVN networking:"
echo " sudo /usr/local/share/spinifex/setup-ovn.sh --management"
echo " # If WAN is a physical NIC (not a bridge), add:"
echo " # --wan-bridge=br-wan --wan-iface=<WAN_NIC> (dedicated WAN NIC)"
echo " # --macvlan --wan-iface=<WAN_NIC> (single-NIC, SSH-safe)"
echo ""
echo " 2. Initialize a region:"
echo " sudo spx admin init --region <region> --az <az> --node node1 --nodes 1"