gsadmin/spinifex
1
0
Fork 0
mirror of https://github.com/mulgadc/spinifex.git synced 2026-10-15 09:01:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: rename product from Hive to Spinifex

Browse Source 
Trademark conflict — bulk rename across entire codebase:
- Go module: github.com/mulgadc/hive → github.com/mulgadc/spinifex
- Binary: hive → spx
- Directories: hive/ → spinifex/, hiveui → spinifexui
- Env vars: HIVE_* → SPINIFEX_*
- Config: hive.toml → spinifex.toml
- Systemd: hive-* → spinifex-*
- NATS: hive-workers → spinifex-workers
- All paths, docs, scripts, CI workflows updated
This commit is contained in:
Ben Duncan
2026-03-18 01:42:53 +00:00
parent 4152e4422f 2064c338b3
commit b95ff42a2f
591 changed files with 2328 additions and 2331 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/e2e.yml
+4 -4
View File
@@ -1,4 +1,4 @@
name: Hive E2E Tests
name: Spinifex E2E Tests
on:
push:
@@ -64,7 +64,7 @@ jobs:
SSH_KEY=$(echo "$INVENTORY" | jq -r '.ssh_key_path')
SSH_KEY="${SSH_KEY/#\~/$HOME}"
ssh -o StrictHostKeyChecking=no -i "$SSH_KEY" tf-user@${WAN_IP} \
'cd ~/Development/mulga/hive && ./tests/e2e/run-e2e.sh'
'cd ~/Development/mulga/spinifex && ./tests/e2e/run-e2e.sh'
- name: Teardown
if: always()
@@ -121,7 +121,7 @@ jobs:
SSH_KEY=$(echo "$INVENTORY" | jq -r '.ssh_key_path')
SSH_KEY="${SSH_KEY/#\~/$HOME}"
ssh -o StrictHostKeyChecking=no -i "$SSH_KEY" tf-user@${WAN_IP} \
'cd ~/Development/mulga/hive && ./tests/e2e/run-pseudo-multinode-e2e.sh'
'cd ~/Development/mulga/spinifex && ./tests/e2e/run-pseudo-multinode-e2e.sh'
- name: Teardown
if: always()
@@ -185,7 +185,7 @@ jobs:
done
ssh -o StrictHostKeyChecking=no -i "$SSH_KEY" tf-user@${NODE1_IP} \
"cd ~/Development/mulga/hive && ./tests/e2e/run-multinode-e2e.sh ${NODE_IPS}"
"cd ~/Development/mulga/spinifex && ./tests/e2e/run-multinode-e2e.sh ${NODE_IPS}"
- name: Teardown
if: always()
.github/workflows/release.yml
+6 -6
View File
@@ -11,10 +11,10 @@ jobs:
distro:
runs-on: ubuntu-24.04
steps:
- name: Checkout Hive
- name: Checkout Spinifex
uses: actions/checkout@v6
with:
path: hive
path: spinifex
- name: Checkout Predastore
uses: actions/checkout@v6
@@ -35,13 +35,13 @@ jobs:
uses: docker/setup-qemu-action@v3
- name: Build distribution tarballs
run: cd hive && make distro VERSION=${{ github.ref_name }}
run: cd spinifex cd hive &&cd hive && make distro VERSION=${{ github.ref_name }}
- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
files: |
hive/dist/*.tar.gz
hive/dist/*.sha256
hive/scripts/setup.sh
spinifex/dist/*.tar.gz
spinifex/dist/*.sha256
spinifex/scripts/setup.sh
generate_release_notes: true
.github/workflows/hive.yml → .github/workflows/spinifex.yml
+14 -14
View File
@@ -1,4 +1,4 @@
name: Hive Build and Test
name: Spinifex Build and Test
on:
push:
@@ -15,11 +15,11 @@ on:
jobs:
build_and_test:
name: Hive Build and Test
name: Spinifex Build and Test
runs-on: ubuntu-24.04
steps:
- name: Checkout Hive
- name: Checkout Spinifex
uses: actions/checkout@v6
with:
path: hive
@@ -40,13 +40,13 @@ jobs:
- name: Setup Go
uses: actions/setup-go@v6
with:
cache-dependency-path: "hive/go.sum"
go-version-file: "hive/go.mod"
cache-dependency-path: "spinifex/go.sum"
go-version-file: "spinifex/go.mod"
- name: Setup Go Workspace
run: go work init ./hive ./viperblock ./predastore
- name: Build Hive
- name: Build Spinifex
run: make -C hive build
- name: Run Tests with Coverage
@@ -56,11 +56,11 @@ jobs:
run: cd hive && scripts/diff-coverage.sh coverage.out --base HEAD~1
race_detection:
name: Hive Race Detection
name: Spinifex Race Detection
runs-on: ubuntu-24.04
steps:
- name: Checkout Hive
- name: Checkout Spinifex
uses: actions/checkout@v6
with:
path: hive
@@ -80,8 +80,8 @@ jobs:
- name: Setup Go
uses: actions/setup-go@v6
with:
cache-dependency-path: "hive/go.sum"
go-version-file: "hive/go.mod"
cache-dependency-path: "spinifex/go.sum"
go-version-file: "spinifex/go.mod"
- name: Setup Go Workspace
run: go work init ./hive ./viperblock ./predastore
@@ -90,11 +90,11 @@ jobs:
run: make -C hive test-race
lint_and_security:
name: Hive Lint and Security
name: Spinifex Lint and Security
runs-on: ubuntu-24.04
steps:
- name: Checkout Hive
- name: Checkout Spinifex
uses: actions/checkout@v6
with:
path: hive
@@ -114,8 +114,8 @@ jobs:
- name: Setup Go
uses: actions/setup-go@v6
with:
cache-dependency-path: "hive/go.sum"
go-version-file: "hive/go.mod"
cache-dependency-path: "spinifex/go.sum"
go-version-file: "spinifex/go.mod"
- name: Setup Go Workspace
run: go work init ./hive ./viperblock ./predastore
.github/workflows/ui.yml
+6 -6
View File
@@ -6,7 +6,7 @@ on:
- main
- dev
paths:
- hive/services/hiveui/frontend/**
- spinifex/services/spinifexui/frontend/**
- .github/workflows/ui.yml
workflow_dispatch:
@@ -16,25 +16,25 @@ jobs:
runs-on: ubuntu-24.04
defaults:
run:
working-directory: hive/services/hiveui/frontend
working-directory: spinifex/services/spinifexui/frontend
steps:
- name: Checkout Code
uses: actions/checkout@v6
with:
sparse-checkout: hive/services/hiveui/frontend
sparse-checkout: spinifex/services/spinifexui/frontend
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
package_json_file: hive/services/hiveui/frontend/package.json
package_json_file: spinifex/services/spinifexui/frontend/package.json
- name: Setup Node.js
uses: actions/setup-node@v6
with:
cache: "pnpm"
cache-dependency-path: hive/services/hiveui/frontend/pnpm-lock.yaml
node-version-file: hive/services/hiveui/frontend/.nvmrc
cache-dependency-path: spinifex/services/spinifexui/frontend/pnpm-lock.yaml
node-version-file: spinifex/services/spinifexui/frontend/.nvmrc
- name: Install Dependencies
run: pnpm install --frozen-lockfile
INSTALL.md
+2 -2
View File
@@ -1,3 +1,3 @@
# Hive Installation
# Spinifex Installation
For documentation on using and installing Hive see [https://docs.mulgadc.com](https://docs.mulgadc.com/)
For documentation on using and installing Spinifex see [https://docs.mulgadc.com](https://docs.mulgadc.com/)
Makefile
+15 -15
View File
@@ -1,4 +1,4 @@
GO_PROJECT_NAME := hive
GO_PROJECT_NAME := spx
SHELL := /bin/bash
# Detect architecture for cross-platform support
@@ -49,19 +49,19 @@ endif
build:
$(MAKE) go_build
# Build hive-ui frontend (requires pnpm)
# Build spinifex-ui frontend (requires pnpm)
build-ui:
@echo -e "\n....Building hive-ui frontend...."
cd hive/services/hiveui/frontend && pnpm build
@echo -e "\n....Building spinifex-ui frontend...."
cd spinifex/services/spinifexui/frontend && pnpm build
# GO commands
VERSION ?= $(shell git describe --tags --always --dirty)
COMMIT ?= $(shell git rev-parse --short HEAD)
LDFLAGS := -s -w -X github.com/mulgadc/hive/cmd/hive/cmd.Version=$(VERSION) -X github.com/mulgadc/hive/cmd/hive/cmd.Commit=$(COMMIT)
LDFLAGS := -s -w -X github.com/mulgadc/spinifex/cmd/spinifex/cmd.Version=$(VERSION) -X github.com/mulgadc/spinifex/cmd/spinifex/cmd.Commit=$(COMMIT)
go_build:
@echo -e "\n....Building $(GO_PROJECT_NAME)"
go build $(GO_BUILD_MOD) -ldflags "$(LDFLAGS)" -o ./bin/$(GO_PROJECT_NAME) cmd/hive/main.go
go build $(GO_BUILD_MOD) -ldflags "$(LDFLAGS)" -o ./bin/$(GO_PROJECT_NAME) cmd/spinifex/main.go
go_run:
@echo -e "\n....Running $(GO_PROJECT_NAME)...."
@@ -76,7 +76,7 @@ preflight:
# Run unit tests
test:
@echo -e "\n....Running tests for $(GO_PROJECT_NAME)...."
LOG_IGNORE=1 go test -timeout 120s ./hive/...
LOG_IGNORE=1 go test -timeout 120s ./spinifex/...
# Run unit tests with coverage profile
# Note: go test may exit non-zero due to Go version mismatch in coverage instrumentation
@@ -84,13 +84,13 @@ test:
COVERPROFILE ?= coverage.out
test-cover:
@echo -e "\n....Running tests with coverage for $(GO_PROJECT_NAME)...."
$(_Q)LOG_IGNORE=1 go test -timeout 120s -coverprofile=$(COVERPROFILE) -covermode=atomic ./hive/... $(_COVQ)
$(_Q)LOG_IGNORE=1 go test -timeout 120s -coverprofile=$(COVERPROFILE) -covermode=atomic ./spinifex/... $(_COVQ)
@scripts/check-coverage.sh $(COVERPROFILE) $(QUIET)
# Run unit tests with race detector
test-race:
@echo -e "\n....Running tests with race detector for $(GO_PROJECT_NAME)...."
$(_Q)LOG_IGNORE=1 go test -race -timeout 300s ./hive/... $(_RACEQ)
$(_Q)LOG_IGNORE=1 go test -race -timeout 300s ./spinifex/... $(_RACEQ)
# Check that new/changed code meets coverage threshold (runs tests first)
diff-coverage: test-cover
@@ -107,7 +107,7 @@ run:
clean:
rm -f ./bin/$(GO_PROJECT_NAME)
rm -rf hive/services/hiveui/frontend/dist
rm -rf spinifex/services/spinifexui/frontend/dist
install-system:
@echo -e "\n....Installing system dependencies for $(ARCH)...."
@@ -199,7 +199,7 @@ security-check:
# Build release tarballs for both architectures via Docker
distro:
@echo "Building hive $(VERSION) distribution tarballs..."
@echo "Building spinifex $(VERSION) distribution tarballs..."
@mkdir -p dist/
@echo "Building linux/amd64..."
docker buildx build \
@@ -208,8 +208,8 @@ distro:
-f build/Dockerfile.distro \
--output type=local,dest=dist/amd64/ \
../
tar -czf dist/hive-$(VERSION)-linux-amd64.tar.gz -C dist/amd64 .
sha256sum dist/hive-$(VERSION)-linux-amd64.tar.gz > dist/hive-$(VERSION)-linux-amd64.tar.gz.sha256
tar -czf dist/spinifex-$(VERSION)-linux-amd64.tar.gz -C dist/amd64 .
sha256sum dist/spinifex-$(VERSION)-linux-amd64.tar.gz > dist/spinifex-$(VERSION)-linux-amd64.tar.gz.sha256
@echo "Building linux/arm64..."
docker buildx build \
--platform linux/arm64 \
@@ -217,8 +217,8 @@ distro:
-f build/Dockerfile.distro \
--output type=local,dest=dist/arm64/ \
../
tar -czf dist/hive-$(VERSION)-linux-arm64.tar.gz -C dist/arm64 .
sha256sum dist/hive-$(VERSION)-linux-arm64.tar.gz > dist/hive-$(VERSION)-linux-arm64.tar.gz.sha256
tar -czf dist/spinifex-$(VERSION)-linux-arm64.tar.gz -C dist/arm64 .
sha256sum dist/spinifex-$(VERSION)-linux-arm64.tar.gz > dist/spinifex-$(VERSION)-linux-arm64.tar.gz.sha256
@echo ""
@echo "Distribution tarballs:"
@ls -lh dist/*.tar.gz
README.md
+15 -15
View File
@@ -1,10 +1,10 @@
# Hive: An Open Source AWS-Compatible Stack for Bare-Metal, Edge, and On-Prem Deployments
# Spinifex: An Open Source AWS-Compatible Stack for Bare-Metal, Edge, and On-Prem Deployments
(Developer Preview) - Hive developed by [Mulga Defense Corporation](https://mulgadc.com/) is an open source infrastructure platform that brings the core services of AWS—like EC2, VPC, EBS, and S3—to environments where running in the cloud isn't an option. Whether you're deploying to edge sites, private data-centers, or need to operate in low-connectivity or highly contested environments, Hive gives you AWS-style workflows on your own hardware.
(Developer Preview) - Spinifex developed by [Mulga Defense Corporation](https://mulgadc.com/) is an open source infrastructure platform that brings the core services of AWS—like EC2, VPC, EBS, and S3—to environments where running in the cloud isn't an option. Whether you're deploying to edge sites, private data-centers, or need to operate in low-connectivity or highly contested environments, Spinifex gives you AWS-style workflows on your own hardware.
## What is Hive?
## What is Spinifex?
Hive replicates essential AWS primitives—virtual machines, block volumes, and object storage—using lightweight, self-contained components that are easy to deploy and integrate.
Spinifex replicates essential AWS primitives—virtual machines, block volumes, and object storage—using lightweight, self-contained components that are easy to deploy and integrate.
It’s designed for developers and operators who need:
@@ -13,13 +13,13 @@ It’s designed for developers and operators who need:
- Drop-in compatibility with tools like the AWS CLI, SDKs, and Terraform
- A secure cloud environment you control and own the entire hardware, network and software stack
You can run Hive on a few servers in a rack, a field site, or anywhere centralized cloud services aren’t feasible.
You can run Spinifex on a few servers in a rack, a field site, or anywhere centralized cloud services aren’t feasible.
## Core Components
### Hive (Compute Service – EC2 Alternative)
### Spinifex (Compute Service – EC2 Alternative)
Hive is a minimal VM orchestration layer built on top of QEMU, exposing APIs similar to EC2. It manages lifecycle operations like start, stop, and terminate, using QEMU’s QMP interface. Designed to be straightforward and scriptable, Hive lets you launch VMs using the AWS CLI, SDKs, or Terraform—without needing Kubernetes or heavyweight orchestrators. Keep in mind, you can also setup a Kubernetes environment using Hive with underlying instances.
Spinifex is a minimal VM orchestration layer built on top of QEMU, exposing APIs similar to EC2. It manages lifecycle operations like start, stop, and terminate, using QEMU’s QMP interface. Designed to be straightforward and scriptable, Spinifex lets you launch VMs using the AWS CLI, SDKs, or Terraform—without needing Kubernetes or heavyweight orchestrators. Keep in mind, you can also setup a Kubernetes environment using Spinifex with underlying instances.
- EC2-like VM management on bare metal
- Launches with cloud-init metadata support
@@ -54,21 +54,21 @@ AWS-Compatible Interfaces – Provision infrastructure with awscli, Terraform, o
## Installation
Installation requires an Ubuntu / Debian system. See the detailed documentation at [https://docs.mulgadc.com](https://docs.mulgadc.com/) for maintaining and installing Hive.
Installation requires an Ubuntu / Debian system. See the detailed documentation at [https://docs.mulgadc.com](https://docs.mulgadc.com/) for maintaining and installing Spinifex.
### Single node install
The installation is straightforward to set up and running on a single node for testing purposes.
```bash
export AWS_PROFILE=hive
export AWS_PROFILE=spinifex
export AWS_REGION=ap-southeast-2-sc
```
```bash
curl https://install.mulgadc.com/ | bash
hive admin init --region $AWS_REGION
spx admin init --region $AWS_REGION
aws ec2 describe-instance-types
```
@@ -79,7 +79,7 @@ For a complete development environment see the [Source Install](https://docs.mul
### Component Repositories
Hive coordinates these independent components:
Spinifex coordinates these independent components:
- **[Predastore](https://github.com/mulgadc/predastore)** - S3-compatible object storage
- **[Viperblock](https://github.com/mulgadc/viperblock)** - EBS-compatible block storage
@@ -90,7 +90,7 @@ Each component can be developed independently. See component-specific documentat
### Built by Engineers, For Engineers
Hive is developed by experienced infrastructure engineers with deep AWS expertise, including former AWS team members who understand the intricacies of building production-grade cloud services. Our team brings decades of combined experience from AWS, enterprise infrastructure, and edge computing environments.
Spinifex is developed by experienced infrastructure engineers with deep AWS expertise, including former AWS team members who understand the intricacies of building production-grade cloud services. Our team brings decades of combined experience from AWS, enterprise infrastructure, and edge computing environments.
**Real-World Experience:**
@@ -101,7 +101,7 @@ Hive is developed by experienced infrastructure engineers with deep AWS expertis
### AI-Assisted Development
While Hive is architected and implemented by experienced engineers, we leverage **Claude Code** (Anthropic's AI coding assistant) to accelerate certain development tasks. This approach combines human expertise with AI efficiency:
While Spinifex is architected and implemented by experienced engineers, we leverage **Claude Code** (Anthropic's AI coding assistant) to accelerate certain development tasks. This approach combines human expertise with AI efficiency:
**How We Use Claude Code:**
@@ -117,8 +117,8 @@ While Hive is architected and implemented by experienced engineers, we leverage
- **Performance Optimization**: Real-world performance tuning and benchmarking
- **Production Operations**: Deployment strategies and operational procedures
This hybrid approach ensures Hive benefits from both proven engineering expertise and modern development acceleration, while maintaining the quality and reliability standards required for production infrastructure.
This hybrid approach ensures Spinifex benefits from both proven engineering expertise and modern development acceleration, while maintaining the quality and reliability standards required for production infrastructure.
## License
Hive is open source under the Apache 2.0 License. You're free to use, modify, and deploy it—anywhere you need reliable infrastructure without depending on centralized cloud platforms.
Spinifex is open source under the Apache 2.0 License. You're free to use, modify, and deploy it—anywhere you need reliable infrastructure without depending on centralized cloud platforms.
build/Dockerfile.distro
+14 -14
View File
@@ -11,38 +11,38 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
WORKDIR /build
# Copy module files for dependency caching
COPY hive/go.mod hive/go.sum ./hive/
COPY spinifex/go.mod spinifex/go.sum ./spinifex/
COPY predastore/go.mod predastore/go.sum ./predastore/
COPY viperblock/go.mod viperblock/go.sum ./viperblock/
COPY viperblock/nbd/go.mod viperblock/nbd/go.sum ./viperblock/nbd/
COPY viperblock/nbd/libguestfs.org/nbdkit/go.mod ./viperblock/nbd/libguestfs.org/nbdkit/
# Generate go.work (gitignored, so not in checkout)
RUN cd hive && go work init . ../predastore ../viperblock ../viperblock/nbd ../viperblock/nbd/libguestfs.org/nbdkit
RUN cd spinifex && go work init . ../predastore ../viperblock ../viperblock/nbd ../viperblock/nbd/libguestfs.org/nbdkit
# Download dependencies (cached layer)
RUN cd hive && go mod download
RUN cd spinifex && go mod download
# Copy full source
COPY hive/ ./hive/
COPY spinifex/ ./spinifex/
COPY predastore/ ./predastore/
COPY viperblock/ ./viperblock/
# Build hive binary
RUN COMMIT=$(cd hive && git rev-parse --short HEAD 2>/dev/null || echo "unknown") && \
cd hive && go build -ldflags "-s -w \
-X github.com/mulgadc/hive/cmd/hive/cmd.Version=${VERSION} \
-X github.com/mulgadc/hive/cmd/hive/cmd.Commit=${COMMIT}" \
-o /out/hive cmd/hive/main.go
# Build spinifex binary (spx)
RUN COMMIT=$(cd spinifex && git rev-parse --short HEAD 2>/dev/null || echo "unknown") && \
cd spinifex && go build -ldflags "-s -w \
-X github.com/mulgadc/spinifex/cmd/spinifex/cmd.Version=${VERSION} \
-X github.com/mulgadc/spinifex/cmd/spinifex/cmd.Commit=${COMMIT}" \
-o /out/spx cmd/spinifex/main.go
# Build nbdkit viperblock plugin (.so)
RUN cd viperblock && go build -o /out/nbdkit-viperblock-plugin.so -buildmode=c-shared nbd/viperblock.go
# Copy setup scripts and systemd units
RUN cp hive/scripts/setup.sh /out/setup.sh 2>/dev/null || true
RUN cp hive/scripts/setup-ovn.sh /out/setup-ovn.sh
RUN mkdir -p /out/systemd && cp hive/build/systemd/* /out/systemd/
RUN cp hive/build/logrotate/hive /out/logrotate-hive
RUN cp spinifex/scripts/setup.sh /out/setup.sh 2>/dev/null || true
RUN cp spinifex/scripts/setup-ovn.sh /out/setup-ovn.sh
RUN mkdir -p /out/systemd && cp spinifex/build/systemd/* /out/systemd/
RUN cp spinifex/build/logrotate/spinifex /out/logrotate-spinifex
FROM scratch AS export
COPY --from=builder /out/ /
build/logrotate/hive → build/logrotate/spinifex
+1 -1
View File
@@ -1,4 +1,4 @@
/var/log/hive/*.log {
/var/log/spinifex/*.log {
daily
rotate 14
compress
build/systemd/hive-awsgw.service
-22
View File
@@ -1,22 +0,0 @@
[Unit]
Description=Hive AWS Gateway
PartOf=hive.target
After=hive-nats.service hive-daemon.service
Requires=hive-nats.service
[Service]
Type=simple
User=hive
Group=hive
ExecStartPre=/bin/sh -c 'for i in $(seq 1 30); do nc -z 127.0.0.1 4222 && exit 0; sleep 1; done; exit 1'
ExecStart=/usr/local/bin/hive service awsgw start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
Environment=HIVE_CONFIG_PATH=/etc/hive/hive.toml
Environment=HIVE_BASE_DIR=/var/lib/hive/
Environment=HIVE_AWSGW_TLS_CERT=/etc/hive/server.pem
Environment=HIVE_AWSGW_TLS_KEY=/etc/hive/server.key
[Install]
WantedBy=hive.target
build/systemd/hive-daemon.service
-21
View File
@@ -1,21 +0,0 @@
[Unit]
Description=Hive Daemon (VM Orchestration)
PartOf=hive.target
After=hive-nats.service hive-viperblock.service
Requires=hive-nats.service
[Service]
Type=simple
User=hive
Group=hive
ExecStartPre=/bin/sh -c 'for i in $(seq 1 30); do nc -z 127.0.0.1 4222 && exit 0; sleep 1; done; exit 1'
ExecStart=/usr/local/bin/hive service hive start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
Environment=HIVE_CONFIG_PATH=/etc/hive/hive.toml
Environment=HIVE_BASE_DIR=/var/lib/hive/hive/
Environment=HIVE_WAL_DIR=/var/lib/hive/hive/
[Install]
WantedBy=hive.target
build/systemd/hive-nats.service
-17
View File
@@ -1,17 +0,0 @@
[Unit]
Description=Hive NATS Message Bus
PartOf=hive.target
Before=hive-predastore.service hive-daemon.service hive-awsgw.service hive-vpcd.service
[Service]
Type=simple
User=hive
Group=hive
ExecStart=/usr/local/bin/hive service nats start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
Environment=HIVE_CONFIG_PATH=/etc/hive/nats/nats.conf
[Install]
WantedBy=hive.target
build/systemd/hive-predastore.service
-22
View File
@@ -1,22 +0,0 @@
[Unit]
Description=Hive Predastore (S3-compatible Object Storage)
PartOf=hive.target
After=hive-nats.service
Requires=hive-nats.service
[Service]
Type=simple
User=hive
Group=hive
ExecStartPre=/bin/sh -c 'for i in $(seq 1 30); do nc -z 127.0.0.1 4222 && exit 0; sleep 1; done; exit 1'
ExecStart=/usr/local/bin/hive service predastore start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
Environment=HIVE_PREDASTORE_CONFIG_PATH=/etc/hive/predastore/predastore.toml
Environment=HIVE_PREDASTORE_BASE_PATH=/var/lib/hive/predastore/
Environment=HIVE_PREDASTORE_TLS_CERT=/etc/hive/server.pem
Environment=HIVE_PREDASTORE_TLS_KEY=/etc/hive/server.key
[Install]
WantedBy=hive.target
build/systemd/hive-ui.service
-16
View File
@@ -1,16 +0,0 @@
[Unit]
Description=Hive Web UI
PartOf=hive.target
After=hive-awsgw.service
[Service]
Type=simple
User=hive
Group=hive
ExecStart=/usr/local/bin/hive service hive-ui start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
[Install]
WantedBy=hive.target
build/systemd/hive-viperblock.service
-21
View File
@@ -1,21 +0,0 @@
[Unit]
Description=Hive Viperblock (Block Storage)
PartOf=hive.target
After=hive-nats.service hive-predastore.service
Requires=hive-nats.service
[Service]
Type=simple
User=hive
Group=hive
ExecStartPre=/bin/sh -c 'for i in $(seq 1 30); do nc -z 127.0.0.1 4222 && exit 0; sleep 1; done; exit 1'
ExecStart=/usr/local/bin/hive service viperblock start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
EnvironmentFile=/etc/hive/systemd.env
Environment=HIVE_CONFIG_PATH=/etc/hive/hive.toml
Environment=HIVE_BASE_DIR=/var/lib/hive/viperblock/
[Install]
WantedBy=hive.target
build/systemd/hive-vpcd.service
-19
View File
@@ -1,19 +0,0 @@
[Unit]
Description=Hive VPC Daemon (OVN Networking)
PartOf=hive.target
After=hive-nats.service hive-daemon.service
Requires=hive-nats.service
[Service]
Type=simple
User=hive
Group=hive
ExecStartPre=/bin/sh -c 'for i in $(seq 1 30); do nc -z 127.0.0.1 4222 && exit 0; sleep 1; done; exit 1'
ExecStart=/usr/local/bin/hive service vpcd start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
Environment=HIVE_CONFIG_PATH=/etc/hive/hive.toml
[Install]
WantedBy=hive.target
build/systemd/hive.target
-8
View File
@@ -1,8 +0,0 @@
[Unit]
Description=Hive Infrastructure Platform
After=network-online.target
Wants=network-online.target
Wants=hive-nats.service hive-predastore.service hive-viperblock.service hive-daemon.service hive-awsgw.service hive-vpcd.service hive-ui.service
[Install]
WantedBy=multi-user.target
build/systemd/spinifex-awsgw.service
+22
View File
@@ -0,0 +1,22 @@
[Unit]
Description=Spinifex AWS Gateway
PartOf=spinifex.target
After=spinifex-nats.service spinifex-daemon.service
Requires=spinifex-nats.service
[Service]
Type=simple
User=spinifex
Group=spinifex
ExecStartPre=/bin/sh -c 'for i in $(seq 1 30); do nc -z 127.0.0.1 4222 && exit 0; sleep 1; done; exit 1'
ExecStart=/usr/local/bin/spx service awsgw start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
Environment=SPINIFEX_CONFIG_PATH=/etc/spinifex/spinifex.toml
Environment=SPINIFEX_BASE_DIR=/var/lib/spinifex/
Environment=SPINIFEX_AWSGW_TLS_CERT=/etc/spinifex/server.pem
Environment=SPINIFEX_AWSGW_TLS_KEY=/etc/spinifex/server.key
[Install]
WantedBy=spinifex.target
build/systemd/spinifex-daemon.service
+21
View File
@@ -0,0 +1,21 @@
[Unit]
Description=Spinifex Daemon (VM Orchestration)
PartOf=spinifex.target
After=spinifex-nats.service spinifex-viperblock.service
Requires=spinifex-nats.service
[Service]
Type=simple
User=spinifex
Group=spinifex
ExecStartPre=/bin/sh -c 'for i in $(seq 1 30); do nc -z 127.0.0.1 4222 && exit 0; sleep 1; done; exit 1'
ExecStart=/usr/local/bin/spx service spinifex start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
Environment=SPINIFEX_CONFIG_PATH=/etc/spinifex/spinifex.toml
Environment=SPINIFEX_BASE_DIR=/var/lib/spinifex/spinifex/
Environment=SPINIFEX_WAL_DIR=/var/lib/spinifex/spinifex/
[Install]
WantedBy=spinifex.target
build/systemd/spinifex-nats.service
+17
View File
@@ -0,0 +1,17 @@
[Unit]
Description=Spinifex NATS Message Bus
PartOf=spinifex.target
Before=spinifex-predastore.service spinifex-daemon.service spinifex-awsgw.service spinifex-vpcd.service
[Service]
Type=simple
User=spinifex
Group=spinifex
ExecStart=/usr/local/bin/spx service nats start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
Environment=SPINIFEX_CONFIG_PATH=/etc/spinifex/nats/nats.conf
[Install]
WantedBy=spinifex.target
build/systemd/spinifex-predastore.service
+22
View File
@@ -0,0 +1,22 @@
[Unit]
Description=Spinifex Predastore (S3-compatible Object Storage)
PartOf=spinifex.target
After=spinifex-nats.service
Requires=spinifex-nats.service
[Service]
Type=simple
User=spinifex
Group=spinifex
ExecStartPre=/bin/sh -c 'for i in $(seq 1 30); do nc -z 127.0.0.1 4222 && exit 0; sleep 1; done; exit 1'
ExecStart=/usr/local/bin/spx service predastore start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
Environment=SPINIFEX_PREDASTORE_CONFIG_PATH=/etc/spinifex/predastore/predastore.toml
Environment=SPINIFEX_PREDASTORE_BASE_PATH=/var/lib/spinifex/predastore/
Environment=SPINIFEX_PREDASTORE_TLS_CERT=/etc/spinifex/server.pem
Environment=SPINIFEX_PREDASTORE_TLS_KEY=/etc/spinifex/server.key
[Install]
WantedBy=spinifex.target
build/systemd/spinifex-ui.service
+16
View File
@@ -0,0 +1,16 @@
[Unit]
Description=Spinifex Web UI
PartOf=spinifex.target
After=spinifex-awsgw.service
[Service]
Type=simple
User=spinifex
Group=spinifex
ExecStart=/usr/local/bin/spx service spinifex-ui start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
[Install]
WantedBy=spinifex.target
build/systemd/spinifex-viperblock.service
+21
View File
@@ -0,0 +1,21 @@
[Unit]
Description=Spinifex Viperblock (Block Storage)
PartOf=spinifex.target
After=spinifex-nats.service spinifex-predastore.service
Requires=spinifex-nats.service
[Service]
Type=simple
User=spinifex
Group=spinifex
ExecStartPre=/bin/sh -c 'for i in $(seq 1 30); do nc -z 127.0.0.1 4222 && exit 0; sleep 1; done; exit 1'
ExecStart=/usr/local/bin/spx service viperblock start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
EnvironmentFile=/etc/spinifex/systemd.env
Environment=SPINIFEX_CONFIG_PATH=/etc/spinifex/spinifex.toml
Environment=SPINIFEX_BASE_DIR=/var/lib/spinifex/viperblock/
[Install]
WantedBy=spinifex.target
build/systemd/spinifex-vpcd.service
+19
View File
@@ -0,0 +1,19 @@
[Unit]
Description=Spinifex VPC Daemon (OVN Networking)
PartOf=spinifex.target
After=spinifex-nats.service spinifex-daemon.service
Requires=spinifex-nats.service
[Service]
Type=simple
User=spinifex
Group=spinifex
ExecStartPre=/bin/sh -c 'for i in $(seq 1 30); do nc -z 127.0.0.1 4222 && exit 0; sleep 1; done; exit 1'
ExecStart=/usr/local/bin/spx service vpcd start
Restart=on-failure
RestartSec=5
OOMScoreAdjust=-500
Environment=SPINIFEX_CONFIG_PATH=/etc/spinifex/spinifex.toml
[Install]
WantedBy=spinifex.target
build/systemd/spinifex.target
+8
View File
@@ -0,0 +1,8 @@
[Unit]
Description=Spinifex Infrastructure Platform
After=network-online.target
Wants=network-online.target
Wants=spinifex-nats.service spinifex-predastore.service spinifex-viperblock.service spinifex-daemon.service spinifex-awsgw.service spinifex-vpcd.service spinifex-ui.service
[Install]
WantedBy=multi-user.target
cmd/hive/cmd/paths.go
-44
View File
@@ -1,44 +0,0 @@
package cmd
import (
"os"
"path/filepath"
)
// DefaultConfigDir returns the default configuration directory.
// Production: /etc/hive (when running as root or /etc/hive exists)
// Development: ~/hive/config
func DefaultConfigDir() string {
if isProductionLayout() {
return "/etc/hive"
}
homeDir, _ := os.UserHomeDir()
return filepath.Join(homeDir, "hive", "config")
}
// DefaultDataDir returns the default data directory.
// Production: /var/lib/hive
// Development: ~/hive
func DefaultDataDir() string {
if isProductionLayout() {
return "/var/lib/hive"
}
homeDir, _ := os.UserHomeDir()
return filepath.Join(homeDir, "hive")
}
// DefaultConfigFile returns the default path to hive.toml.
func DefaultConfigFile() string {
return filepath.Join(DefaultConfigDir(), "hive.toml")
}
// isProductionLayout returns true when running in a production install.
// Detected by: running as root, or /etc/hive directory exists.
func isProductionLayout() bool {
if os.Getuid() == 0 {
if info, err := os.Stat("/etc/hive"); err == nil && info.IsDir() {
return true
}
}
return false
}
cmd/hive/LICENSE → cmd/spinifex/LICENSE
View File
cmd/hive/cmd/admin.go → cmd/spinifex/cmd/admin.go
+53 -53
View File
@@ -34,12 +34,12 @@ import (
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/iam"
"github.com/mulgadc/hive/hive/admin"
"github.com/mulgadc/hive/hive/config"
"github.com/mulgadc/hive/hive/formation"
handlers_ec2_vpc "github.com/mulgadc/hive/hive/handlers/ec2/vpc"
handlers_iam "github.com/mulgadc/hive/hive/handlers/iam"
"github.com/mulgadc/hive/hive/utils"
"github.com/mulgadc/spinifex/spinifex/admin"
"github.com/mulgadc/spinifex/spinifex/config"
"github.com/mulgadc/spinifex/spinifex/formation"
handlers_ec2_vpc "github.com/mulgadc/spinifex/spinifex/handlers/ec2/vpc"
handlers_iam "github.com/mulgadc/spinifex/spinifex/handlers/iam"
"github.com/mulgadc/spinifex/spinifex/utils"
"github.com/mulgadc/viperblock/viperblock"
"github.com/mulgadc/viperblock/viperblock/backends/s3"
"github.com/mulgadc/viperblock/viperblock/v_utils"
@@ -48,8 +48,8 @@ import (
"github.com/spf13/cobra"
)
//go:embed templates/hive.toml
var hiveTomlTemplate string
//go:embed templates/spinifex.toml
var spinifexTomlTemplate string
//go:embed templates/awsgw.toml
var awsgwTomlTemplate string
@@ -101,7 +101,7 @@ var adminInitCmd = &cobra.Command{
Short: "Initialize Hive platform configuration",
Long: `Initialize Hive platform by creating configuration files, generating SSL certificates,
and setting up AWS credentials. This creates the necessary directory structure and
configuration files in ~/hive/config.`,
configuration files in ~/spinifex/config.`,
Run: runAdminInit,
}
@@ -159,18 +159,18 @@ var accountListCmd = &cobra.Command{
/*
CLI ideas
hive admin images list
spx admin images list
- fetches from remote endpoint for common/trusted images to bootstrap environment, or baked in from compile.
// If --name specified, download
hive admin images import --name debian-12-x86_64
spx admin images import --name debian-12-x86_64
// List available images
hive admin images list
spx admin images list
// Manually import a path
hive admin images import --file /path/to/image --distro debian --version 12 --arch x86_64
spx admin images import --file /path/to/image --distro debian --version 12 --arch x86_64
-> x <-
*/
@@ -197,7 +197,7 @@ func init() {
accountCreateCmd.MarkFlagRequired("name")
rootCmd.PersistentFlags().String("config-dir", DefaultConfigDir(), "Configuration directory")
rootCmd.PersistentFlags().String("hive-dir", DefaultDataDir(), "Hive base directory")
rootCmd.PersistentFlags().String("spinifex-dir", DefaultDataDir(), "Spinifex base directory")
// Flags for admin init
adminInitCmd.Flags().Bool("force", false, "Force re-initialization (overwrites existing config)")
@@ -212,7 +212,7 @@ func init() {
adminInitCmd.Flags().String("cluster-routes", "", "NATS cluster hosts for routing specify multiple with comma (e.g., 10.11.12.1:4248,10.11.12.2:4248 for multi-node)")
adminInitCmd.Flags().String("predastore-nodes", "", "Comma-separated IPs for multi-node Predastore cluster (e.g., 10.11.12.1,10.11.12.2,10.11.12.3). Requires >= 3 nodes.")
adminInitCmd.Flags().String("formation-timeout", "10m", "Timeout for cluster formation (e.g., 5m, 30s)")
adminInitCmd.Flags().String("cluster-name", "hive", "NATS cluster name")
adminInitCmd.Flags().String("cluster-name", "spinifex", "NATS cluster name")
adminInitCmd.Flags().StringSlice("services", nil, "Services this node runs (default: all). Valid: nats,predastore,viperblock,daemon,awsgw,ui")
// Flags for admin join
@@ -220,7 +220,7 @@ func init() {
adminJoinCmd.Flags().String("az", "ap-southeast-2a", "Availability zone for this node")
adminJoinCmd.Flags().String("node", "", "Node name (required)")
adminJoinCmd.Flags().String("host", "", "Leader node host:port (e.g., node1.local:4432) (required)")
adminJoinCmd.Flags().String("data-dir", "", "Data directory for this node (default: ~/hive)")
adminJoinCmd.Flags().String("data-dir", "", "Data directory for this node (default: ~/spinifex)")
adminJoinCmd.Flags().Int("port", 4432, "Port to bind cluster services on")
adminJoinCmd.Flags().String("bind", "0.0.0.0", "IP address to bind services to (e.g., 10.11.12.2 for multi-node on single host)")
adminJoinCmd.Flags().String("cluster-bind", "", "IP address to bind NATS cluster services to (e.g., 10.11.12.1 for multi-node)")
@@ -259,7 +259,7 @@ func runimagesImportCmd(cmd *cobra.Command, args []string) {
}
//configDir, _ := cmd.Flags().GetString("config-dir")
baseDir, _ := cmd.Flags().GetString("hive-dir")
baseDir, _ := cmd.Flags().GetString("spinifex-dir")
// Strip trailing slash
baseDir = filepath.Clean(baseDir)
@@ -368,7 +368,7 @@ func runimagesImportCmd(cmd *cobra.Command, args []string) {
}
// Next, validate if the image is raw, tar, gz, xv, etc. We need to upload the raw image
tmpDir, err := os.MkdirTemp(ostmpDir, "hive-image-tmp-*")
tmpDir, err := os.MkdirTemp(ostmpDir, "spinifex-image-tmp-*")
if err != nil {
fmt.Fprintf(os.Stderr, "Could not create temp dir: %v\n", err)
@@ -515,14 +515,14 @@ func runimagesListCmd(cmd *cobra.Command, args []string) {
pterm.Println("To install a selected image as an AMI use:")
pterm.Println("hive admin images import --name <image-name>")
pterm.Println("spx admin images import --name <image-name>")
}
// TODO: Move all logic to a module, use minimal application logic in viper commands
func runAdminInit(cmd *cobra.Command, args []string) {
force, _ := cmd.Flags().GetBool("force")
configDir, _ := cmd.Flags().GetString("config-dir")
hiveRoot, _ := cmd.Flags().GetString("hive-dir")
spxRoot, _ := cmd.Flags().GetString("spinifex-dir")
region, _ := cmd.Flags().GetString("region")
az, _ := cmd.Flags().GetString("az")
node, _ := cmd.Flags().GetString("node")
@@ -568,12 +568,12 @@ func runAdminInit(cmd *cobra.Command, args []string) {
fmt.Printf("Configuration directory: %s\n\n", configDir)
// Check if already initialized
hiveTomlPath := filepath.Join(configDir, "hive.toml")
if !force && admin.FileExists(hiveTomlPath) {
spinifexTomlPath := filepath.Join(configDir, "spinifex.toml")
if !force && admin.FileExists(spinifexTomlPath) {
fmt.Println("⚠️ Hive already initialized!")
fmt.Printf("Config file exists: %s\n", hiveTomlPath)
fmt.Printf("Config file exists: %s\n", spinifexTomlPath)
fmt.Println("\nTo re-initialize, run with --force flag:")
fmt.Println(" hive admin init --force")
fmt.Println(" spx admin init --force")
os.Exit(0)
}
@@ -616,7 +616,7 @@ func runAdminInit(cmd *cobra.Command, args []string) {
fmt.Printf(" Access Key: %s\n", bootstrapResult.AdminAccessKey)
fmt.Printf(" Secret Key: %s\n", bootstrapResult.AdminSecretKey)
fmt.Printf(" Account: %s (%s)\n", admin.DefaultAccountName(), admin.DefaultAccountID())
fmt.Printf(" AWS Profile: hive\n")
fmt.Printf(" AWS Profile: spinifex\n")
// Generate SSL certificates (with bind IP in SANs for multi-node support)
certPath := admin.GenerateCertificatesIfNeeded(configDir, force, bindIP)
@@ -629,17 +629,17 @@ func runAdminInit(cmd *cobra.Command, args []string) {
}
fmt.Println("\n🔒 Generated NATS authentication token")
if hiveRoot == "" {
hiveRoot = DefaultDataDir()
if spxRoot == "" {
spxRoot = DefaultDataDir()
}
hiveRoot = filepath.Clean(hiveRoot)
spxRoot = filepath.Clean(spxRoot)
// Determine if this is a multi-node formation
isMultiNode := nodes >= 2 && bindIP != "0.0.0.0"
if isMultiNode {
runAdminInitMultiNode(cmd, accessKey, secretKey, accountID, natsToken, clusterName,
configDir, hiveRoot, certPath, region, az, node, bindIP, clusterBind,
configDir, spxRoot, certPath, region, az, node, bindIP, clusterBind,
port, nodes, formationTimeoutStr, services)
return
}
@@ -653,9 +653,9 @@ func runAdminInit(cmd *cobra.Command, args []string) {
awsgwDir := filepath.Join(configDir, "awsgw")
predastoreDir := filepath.Join(configDir, "predastore")
natsDir := filepath.Join(configDir, "nats")
hiveDir := filepath.Join(configDir, "hive")
spinifexDir := filepath.Join(configDir, "spinifex")
for _, dir := range []string{awsgwDir, predastoreDir, natsDir, hiveDir} {
for _, dir := range []string{awsgwDir, predastoreDir, natsDir, spinifexDir} {
if err := os.MkdirAll(dir, 0700); err != nil {
fmt.Fprintf(os.Stderr, "Error creating directory %s: %v\n", dir, err)
os.Exit(1)
@@ -713,7 +713,7 @@ func runAdminInit(cmd *cobra.Command, args []string) {
AccountID: accountID,
Region: region,
NatsToken: natsToken,
DataDir: hiveRoot,
DataDir: spxRoot,
ConfigDir: configDir,
Node: node,
@@ -730,7 +730,7 @@ func runAdminInit(cmd *cobra.Command, args []string) {
// Generate config files
configs := []admin.ConfigFile{
{Name: "hive.toml", Path: hiveTomlPath, Template: hiveTomlTemplate},
{Name: "spinifex.toml", Path: spinifexTomlPath, Template: spinifexTomlTemplate},
{Name: filepath.Join(awsgwDir, "awsgw.toml"), Path: filepath.Join(awsgwDir, "awsgw.toml"), Template: awsgwTomlTemplate},
{Name: filepath.Join(natsDir, "nats.conf"), Path: filepath.Join(natsDir, "nats.conf"), Template: natsConfTemplate},
}
@@ -754,7 +754,7 @@ func runAdminInit(cmd *cobra.Command, args []string) {
fmt.Println("✅ AWS credentials configured")
}
admin.CreateServiceDirectories(hiveRoot)
admin.CreateServiceDirectories(spxRoot)
// In production layout (running as root), fix ownership so the service user
// can read config and write data. SUDO_USER identifies the operator account.
@@ -762,7 +762,7 @@ func runAdminInit(cmd *cobra.Command, args []string) {
sudoUser := os.Getenv("SUDO_USER")
if sudoUser != "" {
admin.ChownRecursive(configDir, sudoUser)
admin.ChownRecursive(hiveRoot, sudoUser)
admin.ChownRecursive(spxRoot, sudoUser)
}
}
@@ -773,12 +773,12 @@ func runAdminInit(cmd *cobra.Command, args []string) {
fmt.Println(" ./scripts/start-dev.sh")
fmt.Println()
fmt.Println(" 2. Test with AWS CLI:")
fmt.Println(" export AWS_PROFILE=hive")
fmt.Println(" export AWS_PROFILE=spinifex")
fmt.Println(" aws ec2 describe-instances")
fmt.Println()
fmt.Println("🔗 Configuration:")
fmt.Printf(" Config file: %s\n", hiveTomlPath)
fmt.Printf(" Data directory: %s\n", hiveRoot)
fmt.Printf(" Config file: %s\n", spinifexTomlPath)
fmt.Printf(" Data directory: %s\n", spxRoot)
fmt.Println()
}
@@ -786,7 +786,7 @@ func runAdminInit(cmd *cobra.Command, args []string) {
// It starts a formation server, registers this node, waits for all nodes to join,
// then generates configs with complete cluster topology.
func runAdminInitMultiNode(cmd *cobra.Command, accessKey, secretKey, accountID, natsToken, clusterName,
configDir, hiveRoot, certPath, region, az, node, bindIP, clusterBind string,
configDir, spxRoot, certPath, region, az, node, bindIP, clusterBind string,
port, expectedNodes int, formationTimeoutStr string, services []string) {
formationTimeout, err := time.ParseDuration(formationTimeoutStr)
@@ -860,7 +860,7 @@ func runAdminInitMultiNode(cmd *cobra.Command, accessKey, secretKey, accountID,
fmt.Printf("\n📡 Formation server started on %s\n", formationAddr)
fmt.Printf(" Waiting for %d more node(s) to join...\n", expectedNodes-1)
fmt.Printf(" Other nodes should run: hive admin join --host %s --node <name> --bind <ip>\n\n", formationAddr)
fmt.Printf(" Other nodes should run: spx admin join --host %s --node <name> --bind <ip>\n\n", formationAddr)
// Wait for all nodes to register
if err := fs.WaitForCompletion(formationTimeout); err != nil {
@@ -882,9 +882,9 @@ func runAdminInitMultiNode(cmd *cobra.Command, accessKey, secretKey, accountID,
awsgwDir := filepath.Join(configDir, "awsgw")
predastoreDir := filepath.Join(configDir, "predastore")
natsDir := filepath.Join(configDir, "nats")
hiveDir := filepath.Join(configDir, "hive")
spinifexDir := filepath.Join(configDir, "spinifex")
for _, dir := range []string{awsgwDir, predastoreDir, natsDir, hiveDir} {
for _, dir := range []string{awsgwDir, predastoreDir, natsDir, spinifexDir} {
if err := os.MkdirAll(dir, 0700); err != nil {
fmt.Fprintf(os.Stderr, "Error creating directory %s: %v\n", dir, err)
os.Exit(1)
@@ -912,7 +912,7 @@ func runAdminInitMultiNode(cmd *cobra.Command, accessKey, secretKey, accountID,
fmt.Printf("✅ Created: multi-node predastore.toml (node ID: %d)\n", predastoreNodeID)
}
hiveTomlPath := filepath.Join(configDir, "hive.toml")
spinifexTomlPath := filepath.Join(configDir, "spinifex.toml")
configSettings := admin.ConfigSettings{
AccessKey: accessKey,
@@ -920,7 +920,7 @@ func runAdminInitMultiNode(cmd *cobra.Command, accessKey, secretKey, accountID,
AccountID: accountID,
Region: region,
NatsToken: natsToken,
DataDir: hiveRoot,
DataDir: spxRoot,
ConfigDir: configDir,
Node: node,
@@ -938,7 +938,7 @@ func runAdminInitMultiNode(cmd *cobra.Command, accessKey, secretKey, accountID,
// Generate config files
configs := []admin.ConfigFile{
{Name: "hive.toml", Path: hiveTomlPath, Template: hiveTomlTemplate},
{Name: "spinifex.toml", Path: spinifexTomlPath, Template: spinifexTomlTemplate},
{Name: filepath.Join(awsgwDir, "awsgw.toml"), Path: filepath.Join(awsgwDir, "awsgw.toml"), Template: awsgwTomlTemplate},
{Name: filepath.Join(natsDir, "nats.conf"), Path: filepath.Join(natsDir, "nats.conf"), Template: natsConfTemplate},
}
@@ -962,7 +962,7 @@ func runAdminInitMultiNode(cmd *cobra.Command, accessKey, secretKey, accountID,
fmt.Println("✅ AWS credentials configured")
}
admin.CreateServiceDirectories(hiveRoot)
admin.CreateServiceDirectories(spxRoot)
// Keep formation server running briefly so joining nodes can fetch complete status
fmt.Println("\n⏳ Waiting for joining nodes to fetch cluster data...")
@@ -1061,7 +1061,7 @@ func runAdminJoin(cmd *cobra.Command, args []string) {
resp, err := client.Post(joinURL, "application/json", bytes.NewBuffer(reqBody))
if err != nil {
fmt.Fprintf(os.Stderr, "❌ Error connecting to formation server: %v\n", err)
fmt.Fprintf(os.Stderr, "Make sure the leader node has run 'hive admin init' and is accessible at %s\n", leaderHost)
fmt.Fprintf(os.Stderr, "Make sure the leader node has run 'spx admin init' and is accessible at %s\n", leaderHost)
os.Exit(1)
}
@@ -1188,9 +1188,9 @@ func runAdminJoin(cmd *cobra.Command, args []string) {
awsgwDir := filepath.Join(configDir, "awsgw")
predastoreDir := filepath.Join(configDir, "predastore")
natsDir := filepath.Join(configDir, "nats")
hiveDir := filepath.Join(configDir, "hive")
spinifexDir := filepath.Join(configDir, "spinifex")
for _, dir := range []string{awsgwDir, predastoreDir, natsDir, hiveDir} {
for _, dir := range []string{awsgwDir, predastoreDir, natsDir, spinifexDir} {
if err := os.MkdirAll(dir, 0700); err != nil {
fmt.Fprintf(os.Stderr, "Error creating directory %s: %v\n", dir, err)
os.Exit(1)
@@ -1224,7 +1224,7 @@ func runAdminJoin(cmd *cobra.Command, args []string) {
fmt.Printf("✅ Created: multi-node predastore.toml (node ID: %d)\n", predastoreNodeID)
}
hiveTomlPath := filepath.Join(configDir, "hive.toml")
spinifexTomlPath := filepath.Join(configDir, "spinifex.toml")
configSettings := admin.ConfigSettings{
AccessKey: creds.AccessKey,
@@ -1250,7 +1250,7 @@ func runAdminJoin(cmd *cobra.Command, args []string) {
// Generate config files
configs := []admin.ConfigFile{
{Name: "hive.toml", Path: hiveTomlPath, Template: hiveTomlTemplate},
{Name: "spinifex.toml", Path: spinifexTomlPath, Template: spinifexTomlTemplate},
{Name: filepath.Join(awsgwDir, "awsgw.toml"), Path: filepath.Join(awsgwDir, "awsgw.toml"), Template: awsgwTomlTemplate},
{Name: filepath.Join(natsDir, "nats.conf"), Path: filepath.Join(natsDir, "nats.conf"), Template: natsConfTemplate},
}
@@ -1291,7 +1291,7 @@ func runAdminJoin(cmd *cobra.Command, args []string) {
}
// buildRemoteNodes converts formation NodeInfo into RemoteNode entries,
// excluding the local node. This puts all cluster members into hive.toml
// excluding the local node. This puts all cluster members into spinifex.toml
// so config is the source of truth for expected cluster membership.
func buildRemoteNodes(allNodes map[string]formation.NodeInfo, localNode string) []admin.RemoteNode {
var remote []admin.RemoteNode
@@ -1409,7 +1409,7 @@ func runAccountCreate(cmd *cobra.Command, args []string) {
}
// Configure AWS CLI profile automatically
profileName := "hive-" + strings.ToLower(strings.ReplaceAll(name, " ", "-"))
profileName := "spinifex-" + strings.ToLower(strings.ReplaceAll(name, " ", "-"))
homeDir, _ := os.UserHomeDir()
endpointHost := "localhost"
cmd/hive/cmd/cluster.go → cmd/spinifex/cmd/cluster.go
+3 -3
View File
@@ -7,7 +7,7 @@ import (
"strings"
"time"
"github.com/mulgadc/hive/hive/daemon"
"github.com/mulgadc/spinifex/spinifex/daemon"
"github.com/nats-io/nats.go"
"github.com/spf13/cobra"
)
@@ -77,7 +77,7 @@ func runClusterShutdown(cmd *cobra.Command, args []string) {
// Execute phases sequentially (except INFRA which is fire-and-forget)
for _, phase := range phases {
topic := "hive.cluster.shutdown." + phase
topic := "spinifex.cluster.shutdown." + phase
req := daemon.ShutdownRequest{
Phase: phase,
Force: force,
@@ -106,7 +106,7 @@ func runClusterShutdown(cmd *cobra.Command, args []string) {
// For DRAIN phase, subscribe to progress updates
var progressSub *nats.Subscription
if phase == "drain" {
progressSub, err = nc.Subscribe("hive.cluster.shutdown.progress", func(msg *nats.Msg) {
progressSub, err = nc.Subscribe("spinifex.cluster.shutdown.progress", func(msg *nats.Msg) {
var progress daemon.ShutdownProgress
if err := json.Unmarshal(msg.Data, &progress); err != nil {
return
cmd/hive/cmd/get.go → cmd/spinifex/cmd/get.go
+6 -6
View File
@@ -24,9 +24,9 @@ import (
"strings"
"time"
"github.com/mulgadc/hive/hive/config"
"github.com/mulgadc/hive/hive/types"
"github.com/mulgadc/hive/hive/utils"
"github.com/mulgadc/spinifex/spinifex/config"
"github.com/mulgadc/spinifex/spinifex/types"
"github.com/mulgadc/spinifex/spinifex/utils"
"github.com/nats-io/nats.go"
"github.com/pterm/pterm"
"github.com/spf13/cobra"
@@ -75,7 +75,7 @@ func loadConfigAndConnect() (*config.ClusterConfig, *nats.Conn, error) {
}
// Backfill BaseDir from config file path when not set in the config.
// Config lives at <baseDir>/config/hive.toml, so baseDir is two levels up.
// Config lives at <baseDir>/config/spinifex.toml, so baseDir is two levels up.
if nodeConfig, ok := cfg.Nodes[cfg.Node]; ok && nodeConfig.BaseDir == "" {
nodeConfig.BaseDir = filepath.Dir(filepath.Dir(cfgPath))
cfg.Nodes[cfg.Node] = nodeConfig
@@ -154,7 +154,7 @@ func runGetNodes(cmd *cobra.Command, args []string) {
defer nc.Close()
timeout, _ := cmd.Flags().GetDuration("timeout")
responses, err := collectResponses(nc, "hive.node.status", timeout)
responses, err := collectResponses(nc, "spinifex.node.status", timeout)
if err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
os.Exit(1)
@@ -228,7 +228,7 @@ func runGetVMs(cmd *cobra.Command, args []string) {
defer nc.Close()
timeout, _ := cmd.Flags().GetDuration("timeout")
responses, err := collectResponses(nc, "hive.node.vms", timeout)
responses, err := collectResponses(nc, "spinifex.node.vms", timeout)
if err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
os.Exit(1)
cmd/spinifex/cmd/paths.go
+44
View File
@@ -0,0 +1,44 @@
package cmd
import (
"os"
"path/filepath"
)
// DefaultConfigDir returns the default configuration directory.
// Production: /etc/spinifex (when running as root or /etc/spinifex exists)
// Development: ~/spinifex/config
func DefaultConfigDir() string {
if isProductionLayout() {
return "/etc/spinifex"
}
homeDir, _ := os.UserHomeDir()
return filepath.Join(homeDir, "spinifex", "config")
}
// DefaultDataDir returns the default data directory.
// Production: /var/lib/spinifex
// Development: ~/spinifex
func DefaultDataDir() string {
if isProductionLayout() {
return "/var/lib/spinifex"
}
homeDir, _ := os.UserHomeDir()
return filepath.Join(homeDir, "spinifex")
}
// DefaultConfigFile returns the default path to spinifex.toml.
func DefaultConfigFile() string {
return filepath.Join(DefaultConfigDir(), "spinifex.toml")
}
// isProductionLayout returns true when running in a production install.
// Detected by: running as root, or /etc/spinifex directory exists.
func isProductionLayout() bool {
if os.Getuid() == 0 {
if info, err := os.Stat("/etc/spinifex"); err == nil && info.IsDir() {
return true
}
}
return false
}
cmd/hive/cmd/paths_test.go → cmd/spinifex/cmd/paths_test.go
+4 -4
View File
@@ -7,13 +7,13 @@ import (
)
func TestDefaultConfigDir_Dev(t *testing.T) {
// Non-root user without /etc/hive should get dev paths
// Non-root user without /etc/spinifex should get dev paths
if os.Getuid() == 0 {
t.Skip("test requires non-root user")
}
homeDir, _ := os.UserHomeDir()
expected := filepath.Join(homeDir, "hive", "config")
expected := filepath.Join(homeDir, "spinifex", "config")
got := DefaultConfigDir()
if got != expected {
t.Errorf("DefaultConfigDir() = %q, want %q", got, expected)
@@ -26,7 +26,7 @@ func TestDefaultDataDir_Dev(t *testing.T) {
}
homeDir, _ := os.UserHomeDir()
expected := filepath.Join(homeDir, "hive")
expected := filepath.Join(homeDir, "spinifex")
got := DefaultDataDir()
if got != expected {
t.Errorf("DefaultDataDir() = %q, want %q", got, expected)
@@ -40,7 +40,7 @@ func TestDefaultConfigFile(t *testing.T) {
got := DefaultConfigFile()
homeDir, _ := os.UserHomeDir()
expected := filepath.Join(homeDir, "hive", "config", "hive.toml")
expected := filepath.Join(homeDir, "spinifex", "config", "spinifex.toml")
if got != expected {
t.Errorf("DefaultConfigFile() = %q, want %q", got, expected)
}
cmd/hive/cmd/root.go → cmd/spinifex/cmd/root.go
+18 -21
View File
@@ -19,7 +19,7 @@ import (
"fmt"
"os"
"github.com/mulgadc/hive/hive/config"
"github.com/mulgadc/spinifex/spinifex/config"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)
@@ -32,20 +32,17 @@ var (
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
Use: "hive",
Short: "Hive - Open source AWS-compatible platform for secure edge deployments",
Use: "spx",
Short: "Spinifex - Open source AWS-compatible platform for secure edge deployments",
Long: `
__/\\\________/\\\__/\\\\\\\\\\\__/\\\________/\\\__/\\\\\\\\\\\\\\\_
_\/\\\_______\/\\\_\/////\\\///__\/\\\_______\/\\\_\/\\\///////////__
_\/\\\_______\/\\\_____\/\\\_____\//\\\______/\\\__\/\\\_____________
_\/\\\\\\\\\\\\\\\_____\/\\\______\//\\\____/\\\___\/\\\\\\\\\\\_____
_\/\\\/////////\\\_____\/\\\_______\//\\\__/\\\____\/\\\///////______
_\/\\\_______\/\\\_____\/\\\________\//\\\/\\\_____\/\\\_____________
_\/\\\_______\/\\\_____\/\\\_________\//\\\\\______\/\\\_____________
_\/\\\_______\/\\\__/\\\\\\\\\\\______\//\\\_______\/\\\\\\\\\\\\\\\_
_\///________\///__\///////////________\///________\///////////////__
_____ _____ _____ _ _ _____ ______ ________ __
/ ____| __ \_ _| \ | |_ _| ____| ____\ \ / /
| (___ | |__) || | | \| | | | | |__ | |__ \ V /
\___ \| ___/ | | | . ‘ | | | | __| | __| > <
____) | | _| |_| |\ |_| |_| | | |____ / . \
|_____/|_| |_____|_| \_|_____|_| |______/_/ \_\
Hive – Open source AWS-compatible platform for secure edge deployments.
Spinifex – Open source AWS-compatible platform for secure edge deployments.
Run EC2, VPC, S3, and EBS-like services on bare metal with full control.
Built for environments where running in the cloud isn’t an option.
Whether you’re deploying to edge sites, private data-centers, or operating
@@ -67,38 +64,38 @@ func init() {
// Global flags
rootCmd.PersistentFlags().String("config", "", "config file (required)")
viper.BindEnv("config", "HIVE_CONFIG_PATH")
viper.BindEnv("config", "SPINIFEX_CONFIG_PATH")
viper.BindPFlag("config", rootCmd.PersistentFlags().Lookup("config"))
// Authentication (access_key, secret)
rootCmd.PersistentFlags().String("access-key", "", "AWS access key (overrides config file and env)")
viper.BindEnv("access-key", "HIVE_ACCESS_KEY")
viper.BindEnv("access-key", "SPINIFEX_ACCESS_KEY")
viper.BindPFlag("access-key", rootCmd.PersistentFlags().Lookup("access-key"))
rootCmd.PersistentFlags().String("secret-key", "", "AWS secret key (overrides config file and env)")
viper.BindEnv("secret-key", "HIVE_SECRET_KEY")
viper.BindEnv("secret-key", "SPINIFEX_SECRET_KEY")
viper.BindPFlag("secret-key", rootCmd.PersistentFlags().Lookup("secret-key"))
rootCmd.PersistentFlags().String("host", "", "AWS Endpoint (overrides config file and env)")
viper.BindEnv("host", "HIVE_HOST")
viper.BindEnv("host", "SPINIFEX_HOST")
viper.BindPFlag("host", rootCmd.PersistentFlags().Lookup("host"))
// Viperblock config
rootCmd.PersistentFlags().String("base-dir", "", "Viperblock base directory (overrides config file and env)")
viper.BindEnv("base-dir", "HIVE_BASE_DIR")
viper.BindEnv("base-dir", "SPINIFEX_BASE_DIR")
viper.BindPFlag("base-dir", rootCmd.PersistentFlags().Lookup("base-dir"))
// NATS specific flags
rootCmd.PersistentFlags().String("nats-host", "", "NATS server host (overrides config file and env)")
viper.BindEnv("nats-host", "HIVE_NATS_HOST")
viper.BindEnv("nats-host", "SPINIFEX_NATS_HOST")
viper.BindPFlag("nats-host", rootCmd.PersistentFlags().Lookup("nats-host"))
rootCmd.PersistentFlags().String("nats-token", "", "NATS authentication token (overrides config file and env)")
viper.BindEnv("nats-token", "HIVE_NATS_TOKEN")
viper.BindEnv("nats-token", "SPINIFEX_NATS_TOKEN")
viper.BindPFlag("nats-token", rootCmd.PersistentFlags().Lookup("nats-token"))
rootCmd.PersistentFlags().String("nats-subject", "", "NATS subscription subject (overrides config file and env)")
viper.BindEnv("nats-subject", "HIVE_NATS_SUBJECT")
viper.BindEnv("nats-subject", "SPINIFEX_NATS_SUBJECT")
viper.BindPFlag("nats-subject", rootCmd.PersistentFlags().Lookup("nats-subject"))
// Bind flags to viper
cmd/hive/cmd/service.go → cmd/spinifex/cmd/service.go
+107 -107
View File
@@ -21,21 +21,21 @@ import (
"os"
"strings"
"github.com/mulgadc/hive/hive/config"
"github.com/mulgadc/hive/hive/service"
"github.com/mulgadc/hive/hive/services/hiveui"
"github.com/mulgadc/hive/hive/services/nats"
"github.com/mulgadc/hive/hive/services/predastore"
"github.com/mulgadc/hive/hive/services/viperblockd"
"github.com/mulgadc/hive/hive/services/vpcd"
"github.com/mulgadc/predastore/s3"
"github.com/mulgadc/spinifex/spinifex/config"
"github.com/mulgadc/spinifex/spinifex/service"
"github.com/mulgadc/spinifex/spinifex/services/nats"
"github.com/mulgadc/spinifex/spinifex/services/predastore"
"github.com/mulgadc/spinifex/spinifex/services/spinifexui"
"github.com/mulgadc/spinifex/spinifex/services/viperblockd"
"github.com/mulgadc/spinifex/spinifex/services/vpcd"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)
var serviceCmd = &cobra.Command{
Use: "service",
Short: "Manage Hive services",
Short: "Manage Spinifex services",
}
var predastoreCmd = &cobra.Command{
@@ -53,9 +53,9 @@ var natsCmd = &cobra.Command{
Short: "Manage the nats service",
}
var hiveCmd = &cobra.Command{
Use: "hive",
Short: "Manage the hive service",
var spinifexCmd = &cobra.Command{
Use: "spinifex",
Short: "Manage the spinifex service",
}
var awsgwCmd = &cobra.Command{
@@ -68,10 +68,10 @@ var vpcdCmd = &cobra.Command{
Short: "Manage the vpcd (VPC daemon) service",
}
var hiveUICmd = &cobra.Command{
Use: "hive-ui",
Aliases: []string{"ui", "hiveui"},
Short: "Manage the hive-ui service",
var spinifexUICmd = &cobra.Command{
Use: "spinifex-ui",
Aliases: []string{"ui", "spinifexui"},
Short: "Manage the spinifex-ui service",
}
var predastoreStartCmd = &cobra.Command{
@@ -410,12 +410,12 @@ var natsStatusCmd = &cobra.Command{
},
}
// Repeat for hive
var hiveStartCmd = &cobra.Command{
// Repeat for spinifex
var spinifexStartCmd = &cobra.Command{
Use: "start",
Short: "Start the hive service",
Short: "Start the spinifex service",
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("Starting hive service...")
fmt.Println("Starting spinifex service...")
cfgFile := viper.GetString("config")
@@ -451,53 +451,53 @@ var hiveStartCmd = &cobra.Command{
// Apply changes back to cluster config
clusterConfig.Nodes[clusterConfig.Node] = nodeConfig
svc, err := service.New("hive", clusterConfig)
svc, err := service.New("spinifex", clusterConfig)
if err != nil {
fmt.Println("Error starting hive service:", err)
fmt.Println("Error starting spinifex service:", err)
return
}
// Set config path for cluster manager
if hiveSvc, ok := svc.(interface{ SetConfigPath(string) }); ok {
hiveSvc.SetConfigPath(cfgFile)
if spxSvc, ok := svc.(interface{ SetConfigPath(string) }); ok {
spxSvc.SetConfigPath(cfgFile)
}
if _, err = svc.Start(); err != nil {
fmt.Println("Error starting hive service:", err)
fmt.Println("Error starting spinifex service:", err)
os.Exit(1)
}
fmt.Println("HIVE service started")
fmt.Println("Spinifex service started")
},
}
var hiveStopCmd = &cobra.Command{
var spinifexStopCmd = &cobra.Command{
Use: "stop",
Short: "Stop the hive service",
Short: "Stop the spinifex service",
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("Stopping hive service...")
fmt.Println("Stopping spinifex service...")
service, err := service.New("hive", &config.ClusterConfig{})
service, err := service.New("spinifex", &config.ClusterConfig{})
if err != nil {
fmt.Println("Error stopping hive service:", err)
fmt.Println("Error stopping spinifex service:", err)
return
}
if err = service.Stop(); err != nil {
fmt.Println("Error stopping hive service:", err)
fmt.Println("Error stopping spinifex service:", err)
os.Exit(1)
}
fmt.Println("Hive service stopped")
fmt.Println("Spinifex service stopped")
},
}
var hiveStatusCmd = &cobra.Command{
var spinifexStatusCmd = &cobra.Command{
Use: "status",
Short: "Get status of the hive service",
Short: "Get status of the spinifex service",
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("Hive service status: ...")
fmt.Println("Spinifex service status: ...")
},
}
@@ -601,18 +601,18 @@ var awsgwStatusCmd = &cobra.Command{
},
}
var hiveUIStartCmd = &cobra.Command{
var spinifexUIStartCmd = &cobra.Command{
Use: "start",
Short: "Start the hive-ui service",
Short: "Start the spinifex-ui service",
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("Starting hive-ui service...")
fmt.Println("Starting spinifex-ui service...")
port := viper.GetInt("hive-ui-port")
host := viper.GetString("hive-ui-host")
tlsCert := viper.GetString("hive-ui-tls-cert")
tlsKey := viper.GetString("hive-ui-tls-key")
port := viper.GetInt("spinifex-ui-port")
host := viper.GetString("spinifex-ui-host")
tlsCert := viper.GetString("spinifex-ui-tls-cert")
tlsKey := viper.GetString("spinifex-ui-tls-key")
svc, err := service.New("hive-ui", &hiveui.Config{
svc, err := service.New("spinifex-ui", &spinifexui.Config{
Port: port,
Host: host,
TLSCert: tlsCert,
@@ -620,57 +620,57 @@ var hiveUIStartCmd = &cobra.Command{
})
if err != nil {
fmt.Println("Error starting hive-ui service:", err)
fmt.Println("Error starting spinifex-ui service:", err)
return
}
if _, err = svc.Start(); err != nil {
fmt.Println("Error starting hive-ui service:", err)
fmt.Println("Error starting spinifex-ui service:", err)
os.Exit(1)
}
fmt.Println("hive-ui service started")
fmt.Println("spinifex-ui service started")
},
}
var hiveUIStopCmd = &cobra.Command{
var spinifexUIStopCmd = &cobra.Command{
Use: "stop",
Short: "Stop the hive-ui service",
Short: "Stop the spinifex-ui service",
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("Stopping hive-ui service...")
fmt.Println("Stopping spinifex-ui service...")
svc, err := service.New("hive-ui", &hiveui.Config{})
svc, err := service.New("spinifex-ui", &spinifexui.Config{})
if err != nil {
fmt.Println("Error stopping hive-ui service:", err)
fmt.Println("Error stopping spinifex-ui service:", err)
return
}
if err = svc.Stop(); err != nil {
fmt.Println("Error stopping hive-ui service:", err)
fmt.Println("Error stopping spinifex-ui service:", err)
os.Exit(1)
}
fmt.Println("hive-ui service stopped")
fmt.Println("spinifex-ui service stopped")
},
}
var hiveUIStatusCmd = &cobra.Command{
var spinifexUIStatusCmd = &cobra.Command{
Use: "status",
Short: "Get status of the hive-ui service",
Short: "Get status of the spinifex-ui service",
Run: func(cmd *cobra.Command, args []string) {
svc, err := service.New("hive-ui", &hiveui.Config{})
svc, err := service.New("spinifex-ui", &spinifexui.Config{})
if err != nil {
fmt.Println("Error getting hive-ui service status:", err)
fmt.Println("Error getting spinifex-ui service status:", err)
return
}
status, err := svc.Status()
if err != nil {
fmt.Println("Error getting hive-ui service status:", err)
fmt.Println("Error getting spinifex-ui service status:", err)
return
}
fmt.Println("hive-ui service status:", status)
fmt.Println("spinifex-ui service status:", status)
},
}
@@ -745,7 +745,7 @@ var vpcdStatusCmd = &cobra.Command{
func init() {
viper.SetEnvPrefix("HIVE") // Prefix for environment variables
viper.SetEnvPrefix("SPINIFEX") // Prefix for environment variables
viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
viper.AutomaticEnv() // Read environment variables automatically
@@ -756,47 +756,47 @@ func init() {
// Predastore Port
predastoreCmd.PersistentFlags().Int("port", 8443, "Predastore (S3) port")
viper.BindEnv("port", "HIVE_PREDASTORE_PORT")
viper.BindEnv("port", "SPINIFEX_PREDASTORE_PORT")
viper.BindPFlag("port", predastoreCmd.PersistentFlags().Lookup("port"))
// Predastore Host
predastoreCmd.PersistentFlags().String("host", "0.0.0.0", "Predastore (S3) host")
viper.BindEnv("host", "HIVE_PREDASTORE_HOST")
viper.BindEnv("host", "SPINIFEX_PREDASTORE_HOST")
viper.BindPFlag("host", predastoreCmd.PersistentFlags().Lookup("host"))
// Base path
predastoreCmd.PersistentFlags().String("base-path", "", "Predastore (S3) base path")
viper.BindEnv("base-path", "HIVE_PREDASTORE_BASE_PATH")
viper.BindEnv("base-path", "SPINIFEX_PREDASTORE_BASE_PATH")
viper.BindPFlag("base-path", predastoreCmd.PersistentFlags().Lookup("base-path"))
// Predastore Config Path
predastoreCmd.PersistentFlags().String("config-path", "", "Predastore (S3) config path")
viper.BindEnv("config-path", "HIVE_PREDASTORE_CONFIG_PATH")
viper.BindEnv("config-path", "SPINIFEX_PREDASTORE_CONFIG_PATH")
viper.BindPFlag("config-path", predastoreCmd.PersistentFlags().Lookup("config-path"))
// Predastore Debug
predastoreCmd.PersistentFlags().Bool("debug", false, "Predastore (S3) debug")
viper.BindEnv("debug", "HIVE_PREDASTORE_DEBUG")
viper.BindEnv("debug", "SPINIFEX_PREDASTORE_DEBUG")
viper.BindPFlag("debug", predastoreCmd.PersistentFlags().Lookup("debug"))
// Predastore TLS Cert
predastoreCmd.PersistentFlags().String("tls-cert", "", "Predastore (S3) TLS certificate")
viper.BindEnv("tls-cert", "HIVE_PREDASTORE_TLS_CERT")
viper.BindEnv("tls-cert", "SPINIFEX_PREDASTORE_TLS_CERT")
viper.BindPFlag("tls-cert", predastoreCmd.PersistentFlags().Lookup("tls-cert"))
// Predastore TLS Key
predastoreCmd.PersistentFlags().String("tls-key", "", "Predastore (S3) TLS key")
viper.BindEnv("tls-key", "HIVE_PREDASTORE_TLS_KEY")
viper.BindEnv("tls-key", "SPINIFEX_PREDASTORE_TLS_KEY")
viper.BindPFlag("tls-key", predastoreCmd.PersistentFlags().Lookup("tls-key"))
// Predastore Backend
predastoreCmd.PersistentFlags().String("backend", "distributed", "Predastore (S3) backend")
viper.BindEnv("backend", "HIVE_PREDASTORE_BACKEND")
viper.BindEnv("backend", "SPINIFEX_PREDASTORE_BACKEND")
viper.BindPFlag("backend", predastoreCmd.PersistentFlags().Lookup("backend"))
// Predastore Node ID
predastoreCmd.PersistentFlags().Int("node-id", 0, "Predastore (S3) node ID")
viper.BindEnv("node-id", "HIVE_PREDASTORE_NODE_ID")
viper.BindEnv("node-id", "SPINIFEX_PREDASTORE_NODE_ID")
viper.BindPFlag("node-id", predastoreCmd.PersistentFlags().Lookup("node-id"))
// Predastore CPU Profiling
@@ -816,19 +816,19 @@ func init() {
serviceCmd.AddCommand(viperblockCmd)
viperblockCmd.PersistentFlags().String("s3-host", "0.0.0.0:8443", "Predastore (S3) host URI")
viper.BindEnv("s3-host", "HIVE_VIPERBLOCK_S3_HOST")
viper.BindEnv("s3-host", "SPINIFEX_VIPERBLOCK_S3_HOST")
viper.BindPFlag("s3-host", predastoreCmd.PersistentFlags().Lookup("s3-host"))
viperblockCmd.PersistentFlags().String("s3-bucket", "predastore", "Predastore (S3) bucket")
viper.BindEnv("s3-bucket", "HIVE_VIPERBLOCK_S3_BUCKET")
viper.BindEnv("s3-bucket", "SPINIFEX_VIPERBLOCK_S3_BUCKET")
viper.BindPFlag("s3-bucket", predastoreCmd.PersistentFlags().Lookup("s3-bucket"))
viperblockCmd.PersistentFlags().String("s3-region", "ap-southeast-2", "Predastore (S3) region")
viper.BindEnv("s3-region", "HIVE_VIPERBLOCK_S3_REGION")
viper.BindEnv("s3-region", "SPINIFEX_VIPERBLOCK_S3_REGION")
viper.BindPFlag("s3-region", predastoreCmd.PersistentFlags().Lookup("s3-region"))
viperblockCmd.PersistentFlags().String("plugin-path", "/opt/hive/lib/nbdkit-viperblock-plugin.so", "Pathname to the nbdkit viperblockplugin")
viper.BindEnv("plugin-path", "HIVE_VIPERBLOCK_PLUGIN_PATH")
viperblockCmd.PersistentFlags().String("plugin-path", "/opt/spinifex/lib/nbdkit-viperblock-plugin.so", "Pathname to the nbdkit viperblockplugin")
viper.BindEnv("plugin-path", "SPINIFEX_VIPERBLOCK_PLUGIN_PATH")
viper.BindPFlag("plugin-path", predastoreCmd.PersistentFlags().Lookup("plugin-path"))
viperblockCmd.AddCommand(viperblockStartCmd)
@@ -844,83 +844,83 @@ func init() {
// Add NATS flags
natsCmd.PersistentFlags().Int("port", 4222, "NATS server port")
viper.BindEnv("port", "HIVE_NATS_PORT")
viper.BindEnv("port", "SPINIFEX_NATS_PORT")
viper.BindPFlag("port", natsCmd.PersistentFlags().Lookup("port"))
natsCmd.PersistentFlags().String("host", "0.0.0.0", "NATS server host")
viper.BindEnv("host", "HIVE_NATS_HOST")
viper.BindEnv("host", "SPINIFEX_NATS_HOST")
viper.BindPFlag("host", natsCmd.PersistentFlags().Lookup("host"))
natsCmd.PersistentFlags().Bool("debug", false, "Enable debug logging")
viper.BindEnv("debug", "HIVE_NATS_DEBUG")
viper.BindEnv("debug", "SPINIFEX_NATS_DEBUG")
viper.BindPFlag("debug", natsCmd.PersistentFlags().Lookup("debug"))
natsCmd.PersistentFlags().String("data-dir", "", "NATS data directory")
viper.BindEnv("data-dir", "HIVE_NATS_DATA_DIR")
viper.BindEnv("data-dir", "SPINIFEX_NATS_DATA_DIR")
viper.BindPFlag("data-dir", natsCmd.PersistentFlags().Lookup("data-dir"))
natsCmd.PersistentFlags().Bool("jetstream", false, "Enable JetStream")
viper.BindEnv("jetstream", "HIVE_NATS_JETSTREAM")
viper.BindEnv("jetstream", "SPINIFEX_NATS_JETSTREAM")
viper.BindPFlag("jetstream", natsCmd.PersistentFlags().Lookup("jetstream"))
// Hive
serviceCmd.AddCommand(hiveCmd)
serviceCmd.AddCommand(spinifexCmd)
hiveCmd.AddCommand(hiveStartCmd)
hiveCmd.AddCommand(hiveStopCmd)
hiveCmd.AddCommand(hiveStatusCmd)
spinifexCmd.AddCommand(spinifexStartCmd)
spinifexCmd.AddCommand(spinifexStopCmd)
spinifexCmd.AddCommand(spinifexStatusCmd)
hiveCmd.PersistentFlags().String("wal-dir", "", "Write-ahead log (WAL) directory. Place on high-speed NVMe disk, or tmpfs for development.")
viper.BindEnv("wal-dir", "HIVE_WAL_DIR")
viper.BindPFlag("wal-dir", hiveCmd.PersistentFlags().Lookup("wal-dir"))
spinifexCmd.PersistentFlags().String("wal-dir", "", "Write-ahead log (WAL) directory. Place on high-speed NVMe disk, or tmpfs for development.")
viper.BindEnv("wal-dir", "SPINIFEX_WAL_DIR")
viper.BindPFlag("wal-dir", spinifexCmd.PersistentFlags().Lookup("wal-dir"))
// AWS GW
serviceCmd.AddCommand(awsgwCmd)
awsgwCmd.PersistentFlags().String("host", "0.0.0.0:9999", "AWS Gateway server host")
viper.BindEnv("host", "HIVE_AWSGW_HOST")
viper.BindEnv("host", "SPINIFEX_AWSGW_HOST")
viper.BindPFlag("host", awsgwCmd.PersistentFlags().Lookup("host"))
// AWS GW TLS Cert
awsgwCmd.PersistentFlags().String("tls-cert", "", "AWS Gateway TLS certificate")
viper.BindEnv("tls-cert", "HIVE_AWSGW_TLS_CERT")
viper.BindEnv("tls-cert", "SPINIFEX_AWSGW_TLS_CERT")
viper.BindPFlag("tls-cert", awsgwCmd.PersistentFlags().Lookup("tls-cert"))
// AWS GW TLS Key
awsgwCmd.PersistentFlags().String("tls-key", "", "AWS Gateway TLS key")
viper.BindEnv("tls-key", "HIVE_AWSGW_TLS_KEY")
viper.BindEnv("tls-key", "SPINIFEX_AWSGW_TLS_KEY")
viper.BindPFlag("tls-key", awsgwCmd.PersistentFlags().Lookup("tls-key"))
awsgwCmd.PersistentFlags().Bool("debug", false, "AWS Gateway Debug")
viper.BindEnv("debug", "HIVE_AWSGW_DEBUG")
viper.BindEnv("debug", "SPINIFEX_AWSGW_DEBUG")
viper.BindPFlag("debug", awsgwCmd.PersistentFlags().Lookup("debug"))
awsgwCmd.AddCommand(awsgwStartCmd)
awsgwCmd.AddCommand(awsgwStopCmd)
awsgwCmd.AddCommand(awsgwStatusCmd)
// hive-ui
serviceCmd.AddCommand(hiveUICmd)
// spinifex-ui
serviceCmd.AddCommand(spinifexUICmd)
hiveUICmd.PersistentFlags().Int("port", 3000, "hive-ui server port")
viper.BindEnv("hive-ui-port", "HIVE_UI_PORT")
viper.BindPFlag("hive-ui-port", hiveUICmd.PersistentFlags().Lookup("port"))
spinifexUICmd.PersistentFlags().Int("port", 3000, "spinifex-ui server port")
viper.BindEnv("spinifex-ui-port", "SPINIFEX_UI_PORT")
viper.BindPFlag("spinifex-ui-port", spinifexUICmd.PersistentFlags().Lookup("port"))
hiveUICmd.PersistentFlags().String("host", "0.0.0.0", "hive-ui server host")
viper.BindEnv("hive-ui-host", "HIVE_UI_HOST")
viper.BindPFlag("hive-ui-host", hiveUICmd.PersistentFlags().Lookup("host"))
spinifexUICmd.PersistentFlags().String("host", "0.0.0.0", "spinifex-ui server host")
viper.BindEnv("spinifex-ui-host", "SPINIFEX_UI_HOST")
viper.BindPFlag("spinifex-ui-host", spinifexUICmd.PersistentFlags().Lookup("host"))
hiveUICmd.PersistentFlags().String("tls-cert", "", "TLS certificate path")
viper.BindEnv("hive-ui-tls-cert", "HIVE_UI_TLS_CERT")
viper.BindPFlag("hive-ui-tls-cert", hiveUICmd.PersistentFlags().Lookup("tls-cert"))
spinifexUICmd.PersistentFlags().String("tls-cert", "", "TLS certificate path")
viper.BindEnv("spinifex-ui-tls-cert", "SPINIFEX_UI_TLS_CERT")
viper.BindPFlag("spinifex-ui-tls-cert", spinifexUICmd.PersistentFlags().Lookup("tls-cert"))
hiveUICmd.PersistentFlags().String("tls-key", "", "TLS key path")
viper.BindEnv("hive-ui-tls-key", "HIVE_UI_TLS_KEY")
viper.BindPFlag("hive-ui-tls-key", hiveUICmd.PersistentFlags().Lookup("tls-key"))
spinifexUICmd.PersistentFlags().String("tls-key", "", "TLS key path")
viper.BindEnv("spinifex-ui-tls-key", "SPINIFEX_UI_TLS_KEY")
viper.BindPFlag("spinifex-ui-tls-key", spinifexUICmd.PersistentFlags().Lookup("tls-key"))
hiveUICmd.AddCommand(hiveUIStartCmd)
hiveUICmd.AddCommand(hiveUIStopCmd)
hiveUICmd.AddCommand(hiveUIStatusCmd)
spinifexUICmd.AddCommand(spinifexUIStartCmd)
spinifexUICmd.AddCommand(spinifexUIStopCmd)
spinifexUICmd.AddCommand(spinifexUIStatusCmd)
// vpcd
serviceCmd.AddCommand(vpcdCmd)
cmd/hive/cmd/templates/awsgw.toml → cmd/spinifex/cmd/templates/awsgw.toml
View File
cmd/hive/cmd/templates/nats.conf → cmd/spinifex/cmd/templates/nats.conf
+2 -2
View File
@@ -1,5 +1,5 @@
# NATS Server Configuration
# Generated by Hive admin init
# Generated by Spinifex admin init
# Server configuration
{{- if .BindIP }}
@@ -22,7 +22,7 @@ cluster {
}
{{- end }}
server_name: hive-nats-{{.Node}}
server_name: spinifex-nats-{{.Node}}
# Authorization
authorization {
cmd/hive/cmd/templates/predastore-multinode.toml → cmd/spinifex/cmd/templates/predastore-multinode.toml
View File
cmd/hive/cmd/templates/predastore.toml → cmd/spinifex/cmd/templates/predastore.toml
View File
cmd/hive/cmd/templates/hive.toml → cmd/spinifex/cmd/templates/spinifex.toml
View File
cmd/hive/cmd/top.go → cmd/spinifex/cmd/top.go
+2 -2
View File
@@ -22,7 +22,7 @@ import (
"sort"
"time"
"github.com/mulgadc/hive/hive/types"
"github.com/mulgadc/spinifex/spinifex/types"
"github.com/pterm/pterm"
"github.com/spf13/cobra"
)
@@ -56,7 +56,7 @@ func runTopNodes(cmd *cobra.Command, args []string) {
defer nc.Close()
timeout, _ := cmd.Flags().GetDuration("timeout")
responses, err := collectResponses(nc, "hive.node.status", timeout)
responses, err := collectResponses(nc, "spinifex.node.status", timeout)
if err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
os.Exit(1)
cmd/hive/cmd/version.go → cmd/spinifex/cmd/version.go
+1 -1
View File
@@ -8,7 +8,7 @@ import (
)
// Version variables set via ldflags at build time.
// Example: go build -ldflags "-X github.com/mulgadc/hive/cmd/hive/cmd.Version=v1.0.0"
// Example: go build -ldflags "-X github.com/mulgadc/spinifex/cmd/spinifex/cmd.Version=v1.0.0"
var (
Version = "dev"
Commit = "unknown"
cmd/hive/cmd/version_test.go → cmd/spinifex/cmd/version_test.go
View File
cmd/hive/main.go → cmd/spinifex/main.go
+1 -1
View File
@@ -15,7 +15,7 @@ limitations under the License.
*/
package main
import "github.com/mulgadc/hive/cmd/hive/cmd"
import "github.com/mulgadc/spinifex/cmd/spinifex/cmd"
func main() {
cmd.Execute()
config/README.md
+44 -44
View File
@@ -1,71 +1,71 @@
# Hive Systemd Service
# Spinifex Systemd Service
This directory contains the systemd service configuration for running Hive services on Ubuntu and Debian systems.
This directory contains the systemd service configuration for running Spinifex services on Ubuntu and Debian systems.
## Files
- `hive.service` - The systemd service file that manages all Hive services
- `install-hive-service.sh` - Installation script to set up the service
- `spinifex.service` - The systemd service file that manages all Spinifex services
- `install-spinifex-service.sh` - Installation script to set up the service
- `README.md` - This documentation file
## Installation
### Prerequisites
1. Ensure Hive is installed in `/opt/hive/`
2. Ensure the `hive` binary is available at `/opt/hive/bin/hive`
1. Ensure Spinifex is installed in `/opt/spinifex/`
2. Ensure the `spx` binary is available at `/opt/spinifex/bin/spx`
3. Run the installation script as root
### Setup Configuration
```
/opt/hive/bin/hive admin init
/opt/spinifex/bin/spx admin init
```
This will init the Hive environment and create the default configuration files in the home directory, e.g `~/hive/`.
This will init the Spinifex environment and create the default configuration files in the home directory, e.g `~/spinifex/`.
```
/home/username/hive:
/home/username/spinifex:
amis config images logs nats predastore state viperblock volumes
/home/username/hive/amis:
/home/username/spinifex/amis:
/home/username/hive/config:
awsgw hive.toml nats predastore server.key server.pem
/home/username/spinifex/config:
awsgw spinifex.toml nats predastore server.key server.pem
/home/username/hive/config/awsgw:
/home/username/spinifex/config/awsgw:
awsgw.toml
/home/username/hive/config/nats:
/home/username/spinifex/config/nats:
nats.conf
/home/username/hive/config/predastore:
/home/username/spinifex/config/predastore:
predastore.toml
/home/username/hive/images:
/home/username/spinifex/images:
/home/username/hive/logs:
awsgw.log awsgw.pid hive.log hive.pid nats.log nats.pid predastore.log predastore.pid viperblock.log viperblock.pid
/home/username/spinifex/logs:
awsgw.log awsgw.pid spinifex.log spinifex.pid nats.log nats.pid predastore.log predastore.pid viperblock.log viperblock.pid
/home/username/hive/nats:
/home/username/spinifex/nats:
/home/username/hive/predastore:
/home/username/spinifex/predastore:
data
/home/username/hive/predastore/data:
/home/username/spinifex/predastore/data:
predastore
/home/ben/hive/state:
/home/ben/spinifex/state:
/home/ben/hive/viperblock:
/home/ben/spinifex/viperblock:
/home/ben/hive/volumes:
/home/ben/spinifex/volumes:
```
### Quick Installation
```bash
sudo ./config/install-hive-service.sh
sudo ./config/install-spinifex-service.sh
```
### Manual Installation
@@ -74,7 +74,7 @@ If you prefer to install manually:
1. Copy the service file:
```bash
sudo cp config/hive.service /etc/systemd/system/
sudo cp config/spinifex.service /etc/systemd/system/
```
2. Reload systemd:
@@ -84,44 +84,44 @@ If you prefer to install manually:
3. Enable the service:
```bash
sudo systemctl enable hive.service
sudo systemctl enable spinifex.service
```
## Service Management
### Start the service
```bash
sudo systemctl start hive
sudo systemctl start spinifex
```
### Stop the service
```bash
sudo systemctl stop hive
sudo systemctl stop spinifex
```
### Check service status
```bash
sudo systemctl status hive
sudo systemctl status spinifex
```
### Restart the service
```bash
sudo systemctl restart hive
sudo systemctl restart spinifex
```
### View service logs
```bash
sudo journalctl -u hive -f
sudo journalctl -u spinifex -f
```
### Disable auto-start
```bash
sudo systemctl disable hive
sudo systemctl disable spinifex
```
## Service Details
The `hive.service` file:
The `spinifex.service` file:
- Starts services in the correct order: NATS → Predastore → Viperblock
- Includes proper delays between service starts to ensure dependencies are ready
@@ -143,41 +143,41 @@ The service starts the following components in order:
### Check if the service is running
```bash
sudo systemctl is-active hive
sudo systemctl is-active spinifex
```
### View recent logs
```bash
sudo journalctl -u hive --since "1 hour ago"
sudo journalctl -u spinifex --since "1 hour ago"
```
### Check service configuration
```bash
sudo systemctl cat hive
sudo systemctl cat spinifex
```
### Verify binary exists
```bash
ls -la /opt/hive/bin/hive
ls -la /opt/spinifex/bin/spx
```
### Test service commands manually
```bash
/opt/hive/bin/hive service nats start
/opt/hive/bin/hive service predastore start
/opt/hive/bin/hive service viperblock start
/opt/spinifex/bin/spx service nats start
/opt/spinifex/bin/spx service predastore start
/opt/spinifex/bin/spx service viperblock start
```
## Customization
If you need to modify the service configuration:
1. Edit the service file: `sudo nano /etc/systemd/system/hive.service`
1. Edit the service file: `sudo nano /etc/systemd/system/spinifex.service`
2. Reload systemd: `sudo systemctl daemon-reload`
3. Restart the service: `sudo systemctl restart hive`
3. Restart the service: `sudo systemctl restart spinifex`
## Security Notes
- The service runs as root, which is necessary for system-level services
- Security hardening is enabled with `ProtectSystem=strict` and `NoNewPrivileges=true`
- Only specific paths are writable: `/opt/hive`, `/var/log`, `/var/run`
- Only specific paths are writable: `/opt/spinifex`, `/var/log`, `/var/run`
config/hive.service
-49
View File
@@ -1,49 +0,0 @@
[Unit]
Description=Hive Services
Documentation=https://github.com/mulgadc/hive
After=network.target
Wants=network.target
[Service]
Type=oneshot
RemainAfterExit=yes
User=root
Group=root
WorkingDirectory=/opt/hive
Environment=PATH=/opt/hive/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
# Start NATS service
ExecStart=/opt/hive/bin/hive service nats start
ExecStartPost=/bin/sleep 3
# Start Predastore service
ExecStart=/opt/hive/bin/hive service predastore start
ExecStartPost=/bin/sleep 2
# Start Viperblock service
ExecStart=/opt/hive/bin/hive service viperblock start
# Stop services in reverse order
ExecStop=/opt/hive/bin/hive service viperblock stop
ExecStopPost=/bin/sleep 2
ExecStop=/opt/hive/bin/hive service predastore stop
ExecStopPost=/bin/sleep 2
ExecStop=/opt/hive/bin/hive service nats stop
# Restart policy
Restart=on-failure
RestartSec=10
# Security settings
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=true
ReadWritePaths=/opt/hive /var/log /var/run
# Logging
StandardOutput=journal
StandardError=journal
SyslogIdentifier=hive
[Install]
WantedBy=multi-user.target
config/install-hive-service.sh → config/install-spinifex-service.sh
+14 -14
View File
@@ -1,7 +1,7 @@
#!/bin/bash
# Hive Service Installation Script
# This script installs the hive systemd service on Ubuntu/Debian systems
# Spinifex Service Installation Script
# This script installs the spinifex systemd service on Ubuntu/Debian systems
set -e
@@ -38,7 +38,7 @@ fi
# Get the directory where this script is located
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SERVICE_FILE="$SCRIPT_DIR/hive.service"
SERVICE_FILE="$SCRIPT_DIR/spinifex.service"
# Check if service file exists
if [[ ! -f "$SERVICE_FILE" ]]; then
@@ -46,7 +46,7 @@ if [[ ! -f "$SERVICE_FILE" ]]; then
exit 1
fi
print_status "Installing Hive systemd service..."
print_status "Installing Spinifex systemd service..."
# Copy service file to systemd directory
cp "$SERVICE_FILE" /etc/systemd/system/
@@ -55,20 +55,20 @@ cp "$SERVICE_FILE" /etc/systemd/system/
systemctl daemon-reload
# Enable the service to start on boot
systemctl enable hive.service
systemctl enable spinifex.service
print_status "Service installed successfully!"
print_status "You can now use the following commands:"
echo " systemctl start hive # Start the service"
echo " systemctl stop hive # Stop the service"
echo " systemctl status hive # Check service status"
echo " systemctl restart hive # Restart the service"
echo " journalctl -u hive -f # View service logs"
echo " systemctl start spinifex # Start the service"
echo " systemctl stop spinifex # Stop the service"
echo " systemctl status spinifex # Check service status"
echo " systemctl restart spinifex # Restart the service"
echo " journalctl -u spinifex -f # View service logs"
# Check if hive binary exists
if [[ ! -f "/opt/hive/bin/hive" ]]; then
print_warning "Hive binary not found at /opt/hive/bin/hive"
print_warning "Please ensure hive is installed in /opt/hive before starting the service"
# Check if spinifex binary exists
if [[ ! -f "/opt/spinifex/bin/spinifex" ]]; then
print_warning "Spinifex binary not found at /opt/spinifex/bin/spinifex"
print_warning "Please ensure spinifex is installed in /opt/spinifex before starting the service"
fi
print_status "Installation complete!"
config/spinifex.service
+49
View File
@@ -0,0 +1,49 @@
[Unit]
Description=Spinifex Services
Documentation=https://github.com/mulgadc/spinifex
After=network.target
Wants=network.target
[Service]
Type=oneshot
RemainAfterExit=yes
User=root
Group=root
WorkingDirectory=/opt/spinifex
Environment=PATH=/opt/spinifex/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
# Start NATS service
ExecStart=/opt/spinifex/bin/spinifex service nats start
ExecStartPost=/bin/sleep 3
# Start Predastore service
ExecStart=/opt/spinifex/bin/spinifex service predastore start
ExecStartPost=/bin/sleep 2
# Start Viperblock service
ExecStart=/opt/spinifex/bin/spinifex service viperblock start
# Stop services in reverse order
ExecStop=/opt/spinifex/bin/spinifex service viperblock stop
ExecStopPost=/bin/sleep 2
ExecStop=/opt/spinifex/bin/spinifex service predastore stop
ExecStopPost=/bin/sleep 2
ExecStop=/opt/spinifex/bin/spinifex service nats stop
# Restart policy
Restart=on-failure
RestartSec=10
# Security settings
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=true
ReadWritePaths=/opt/spinifex /var/log /var/run
# Logging
StandardOutput=journal
StandardError=journal
SyslogIdentifier=spinifex
[Install]
WantedBy=multi-user.target
docs/COMMANDS.md
+62 -62
View File
@@ -1,36 +1,36 @@
# Command Implementation Matrix
## Hive Admin CLI
## Spinifex Admin CLI
Platform management commands not exposed via the AWS gateway API. These are CLI-only commands.
### Service Management
Service lifecycle commands for starting, stopping, and checking status of all Hive cluster services. Each service subcommand supports `start`, `stop`, and `status` operations.
Service lifecycle commands for starting, stopping, and checking status of all Spinifex cluster services. Each service subcommand supports `start`, `stop`, and `status` operations.
| Command | Flags | Prerequisites | Basic Logic | Status |
|---------|-------|---------------|-------------|--------|
| `hive service predastore start` | `--port` (default: 8443), `--host` (default: 0.0.0.0), `--base-path`, `--config-path`, `--debug`, `--tls-cert`, `--tls-key`, `--backend` (distributed/filesystem, default: distributed), `--node-id` (default: 0), `--pprof`, `--pprof-output` | TLS cert/key, base-path, config-path required | Creates predastore service instance with S3-compatible storage backend → starts service | **DONE** |
| `hive service predastore stop` | — | Predastore must be running | Stops the predastore service | **DONE** |
| `hive service predastore status` | — | None | Reports predastore service status | **DONE** |
| `hive service viperblock start` | `--s3-host` (default: 0.0.0.0:8443), `--s3-bucket` (default: predastore), `--s3-region` (default: ap-southeast-2), `--plugin-path` (default: /opt/hive/lib/nbdkit-viperblock-plugin.so) | `--config` required, plugin-path must exist on disk | Loads cluster config → connects to NATS and Predastore → starts viperblock block storage service with NBD plugin | **DONE** |
| `hive service viperblock stop` | — | Viperblock must be running | Stops the viperblock service | **DONE** |
| `hive service viperblock status` | — | None | Reports viperblock service status | **DONE** |
| `hive service nats start` | `--port` (default: 4222), `--host` (default: 0.0.0.0), `--debug`, `--data-dir`, `--jetstream` | None | Starts embedded NATS server with optional JetStream | **DONE** |
| `hive service nats stop` | — | NATS must be running | Stops the NATS service | **DONE** |
| `hive service nats status` | — | None | Reports NATS service status | **DONE** |
| `hive service hive start` | `--wal-dir` | `--config` required | Loads cluster config → starts hive daemon (VM orchestration, NATS subscriptions, health endpoint) | **DONE** |
| `hive service hive stop` | — | Hive daemon must be running | Stops the hive daemon service | **DONE** |
| `hive service hive status` | — | None | Reports hive daemon service status | **DONE** |
| `hive service awsgw start` | `--host` (default: 0.0.0.0:9999), `--tls-cert`, `--tls-key`, `--debug` | `--config` required | Loads cluster config → starts AWS-compatible gateway with SigV4 auth, IAM policy enforcement, TLS | **DONE** |
| `hive service awsgw stop` | — | AWS gateway must be running | Stops the AWS gateway service | **DONE** |
| `hive service awsgw status` | — | None | Reports AWS gateway service status | **DONE** |
| `hive service hive-ui start` | `--port` (default: 3000), `--host` (default: 0.0.0.0), `--tls-cert`, `--tls-key` | None | Starts embedded web UI server serving the React frontend. Aliases: `ui`, `hiveui` | **DONE** |
| `hive service hive-ui stop` | — | hive-ui must be running | Stops the hive-ui service | **DONE** |
| `hive service hive-ui status` | — | None | Reports hive-ui service status | **DONE** |
| `hive service vpcd start` | — | `--config` required, OVN/OVS installed | Loads cluster config → starts VPC daemon (subscribes to `vpc.*` NATS events, translates to OVN logical switches/ports/routers) | **DONE** |
| `hive service vpcd stop` | — | vpcd must be running | Stops the vpcd service | **DONE** |
| `hive service vpcd status` | — | None | Reports vpcd service status | **DONE** |
| `spx service predastore start` | `--port` (default: 8443), `--host` (default: 0.0.0.0), `--base-path`, `--config-path`, `--debug`, `--tls-cert`, `--tls-key`, `--backend` (distributed/filesystem, default: distributed), `--node-id` (default: 0), `--pprof`, `--pprof-output` | TLS cert/key, base-path, config-path required | Creates predastore service instance with S3-compatible storage backend → starts service | **DONE** |
| `spx service predastore stop` | — | Predastore must be running | Stops the predastore service | **DONE** |
| `spx service predastore status` | — | None | Reports predastore service status | **DONE** |
| `spx service viperblock start` | `--s3-host` (default: 0.0.0.0:8443), `--s3-bucket` (default: predastore), `--s3-region` (default: ap-southeast-2), `--plugin-path` (default: /opt/spinifex/lib/nbdkit-viperblock-plugin.so) | `--config` required, plugin-path must exist on disk | Loads cluster config → connects to NATS and Predastore → starts viperblock block storage service with NBD plugin | **DONE** |
| `spx service viperblock stop` | — | Viperblock must be running | Stops the viperblock service | **DONE** |
| `spx service viperblock status` | — | None | Reports viperblock service status | **DONE** |
| `spx service nats start` | `--port` (default: 4222), `--host` (default: 0.0.0.0), `--debug`, `--data-dir`, `--jetstream` | None | Starts embedded NATS server with optional JetStream | **DONE** |
| `spx service nats stop` | — | NATS must be running | Stops the NATS service | **DONE** |
| `spx service nats status` | — | None | Reports NATS service status | **DONE** |
| `spx service spinifex start` | `--wal-dir` | `--config` required | Loads cluster config → starts spinifex daemon (VM orchestration, NATS subscriptions, health endpoint) | **DONE** |
| `spx service spinifex stop` | — | Spinifex daemon must be running | Stops the spinifex daemon service | **DONE** |
| `spx service spinifex status` | — | None | Reports spinifex daemon service status | **DONE** |
| `spx service awsgw start` | `--host` (default: 0.0.0.0:9999), `--tls-cert`, `--tls-key`, `--debug` | `--config` required | Loads cluster config → starts AWS-compatible gateway with SigV4 auth, IAM policy enforcement, TLS | **DONE** |
| `spx service awsgw stop` | — | AWS gateway must be running | Stops the AWS gateway service | **DONE** |
| `spx service awsgw status` | — | None | Reports AWS gateway service status | **DONE** |
| `spx service spinifex-ui start` | `--port` (default: 3000), `--host` (default: 0.0.0.0), `--tls-cert`, `--tls-key` | None | Starts embedded web UI server serving the React frontend. Aliases: `ui`, `spinifexui` | **DONE** |
| `spx service spinifex-ui stop` | — | spinifex-ui must be running | Stops the spinifex-ui service | **DONE** |
| `spx service spinifex-ui status` | — | None | Reports spinifex-ui service status | **DONE** |
| `spx service vpcd start` | — | `--config` required, OVN/OVS installed | Loads cluster config → starts VPC daemon (subscribes to `vpc.*` NATS events, translates to OVN logical switches/ports/routers) | **DONE** |
| `spx service vpcd stop` | — | vpcd must be running | Stops the vpcd service | **DONE** |
| `spx service vpcd status` | — | None | Reports vpcd service status | **DONE** |
### Cluster Inspection
@@ -38,41 +38,41 @@ Operational commands for inspecting cluster state. These fan out NATS requests t
| Command | Flags | Prerequisites | Basic Logic | Output Columns | Status |
|---------|-------|---------------|-------------|----------------|--------|
| `hive get nodes` | `--timeout` (default: 3s) | Cluster must be running (NATS) | Loads config → publishes to `hive.node.status` fan-out topic → collects responses within timeout → merges config-known nodes with NATS responders → nodes that don't respond shown as `NotReady` | NAME, STATUS, IP, REGION, AZ, UPTIME, VMs, SERVICES | **DONE** |
| `hive get vms` | `--timeout` (default: 3s) | Cluster must be running (NATS) | Publishes to `hive.node.vms` fan-out topic → collects VM info from all nodes → sorts by node then instance ID → prints table. Alias: `hive get instances` | INSTANCE, STATUS, TYPE, VCPU, MEM, NODE, IP, AGE | **DONE** |
| `spx get nodes` | `--timeout` (default: 3s) | Cluster must be running (NATS) | Loads config → publishes to `spinifex.node.status` fan-out topic → collects responses within timeout → merges config-known nodes with NATS responders → nodes that don't respond shown as `NotReady` | NAME, STATUS, IP, REGION, AZ, UPTIME, VMs, SERVICES | **DONE** |
| `spx get vms` | `--timeout` (default: 3s) | Cluster must be running (NATS) | Publishes to `spinifex.node.vms` fan-out topic → collects VM info from all nodes → sorts by node then instance ID → prints table. Alias: `spx get instances` | INSTANCE, STATUS, TYPE, VCPU, MEM, NODE, IP, AGE | **DONE** |
### Resource Monitoring
| Command | Flags | Prerequisites | Basic Logic | Output | Status |
|---------|-------|---------------|-------------|--------|--------|
| `hive top nodes` | `--timeout` (default: 3s) | Cluster must be running (NATS) | Publishes to `hive.node.status` fan-out topic → collects CPU/memory usage per node → aggregates instance type capacity across all nodes → prints two tables: per-node resource usage and cluster-wide instance type availability | Table 1: NAME, CPU (used/total), MEM (used/total), VMs. Table 2: INSTANCE TYPE, AVAILABLE, VCPU, MEMORY | **DONE** |
| `spx top nodes` | `--timeout` (default: 3s) | Cluster must be running (NATS) | Publishes to `spinifex.node.status` fan-out topic → collects CPU/memory usage per node → aggregates instance type capacity across all nodes → prints two tables: per-node resource usage and cluster-wide instance type availability | Table 1: NAME, CPU (used/total), MEM (used/total), VMs. Table 2: INSTANCE TYPE, AVAILABLE, VCPU, MEMORY | **DONE** |
### Cluster Initialization
| Command | Flags | Prerequisites | Basic Logic | Test Cases | Status |
|---------|-------|---------------|-------------|------------|--------|
| `hive admin init` | `--nodes`, `--node`, `--bind`, `--port`, `--region`, `--az`, `--cluster-name`, `--cluster-bind`, `--cluster-routes`, `--predastore-nodes`, `--services`, `--formation-timeout`, `--force` | None (first-time setup) | Generates root IAM credentials (AKIA-prefixed access key + secret) → creates master.key (AES-256, 32 bytes, 0600) → writes bootstrap.json (consumed on first start) → generates CA + server TLS certificates → creates NATS config with auth token → writes hive.toml, awsgw.toml, predastore.toml → configures AWS CLI `hive` profile → creates directory structure under `~/hive/` | 1. Init creates all config files<br>2. Root credentials printed once<br>3. master.key is 32 bytes, mode 0600<br>4. bootstrap.json consumed on first start<br>5. `--force` re-initializes existing config<br>6. AWS CLI profile `hive` auto-configured | **DONE** |
| `hive admin join` | `--host` (required), `--node` (required), `--bind`, `--port`, `--region`, `--az`, `--cluster-bind`, `--cluster-routes`, `--data-dir`, `--services` | Leader node must be running | Connects to leader node → retrieves cluster configuration → configures local node to join cluster and participate in distributed operations | 1. Join existing cluster<br>2. Missing host (error)<br>3. Missing node name (error) | **DONE** |
| `spx admin init` | `--nodes`, `--node`, `--bind`, `--port`, `--region`, `--az`, `--cluster-name`, `--cluster-bind`, `--cluster-routes`, `--predastore-nodes`, `--services`, `--formation-timeout`, `--force` | None (first-time setup) | Generates root IAM credentials (AKIA-prefixed access key + secret) → creates master.key (AES-256, 32 bytes, 0600) → writes bootstrap.json (consumed on first start) → generates CA + server TLS certificates → creates NATS config with auth token → writes spinifex.toml, awsgw.toml, predastore.toml → configures AWS CLI `spx` profile → creates directory structure under `~/spinifex/` | 1. Init creates all config files<br>2. Root credentials printed once<br>3. master.key is 32 bytes, mode 0600<br>4. bootstrap.json consumed on first start<br>5. `--force` re-initializes existing config<br>6. AWS CLI profile `spx` auto-configured | **DONE** |
| `spx admin join` | `--host` (required), `--node` (required), `--bind`, `--port`, `--region`, `--az`, `--cluster-bind`, `--cluster-routes`, `--data-dir`, `--services` | Leader node must be running | Connects to leader node → retrieves cluster configuration → configures local node to join cluster and participate in distributed operations | 1. Join existing cluster<br>2. Missing host (error)<br>3. Missing node name (error) | **DONE** |
### Cluster Operations
| Command | Flags | Prerequisites | Basic Logic | Test Cases | Status |
|---------|-------|---------------|-------------|------------|--------|
| `hive admin cluster shutdown` | — | Cluster must be running | Gracefully shuts down the entire cluster | 1. Shutdown running cluster<br>2. All nodes stop cleanly | **DONE** |
| `spx admin cluster shutdown` | — | Cluster must be running | Gracefully shuts down the entire cluster | 1. Shutdown running cluster<br>2. All nodes stop cleanly | **DONE** |
### Account Management
| Command | Flags | Prerequisites | Basic Logic | Test Cases | Status |
|---------|-------|---------------|-------------|------------|--------|
| `hive admin account create` | `--name` | Cluster must be running (NATS), master key must exist | Connects to NATS → CAS loop on `hive-account-counter:next_id` for sequential 12-digit ID → creates Account record in `hive-accounts` KV → creates `admin` user in new account → creates access key for admin → creates AdministratorAccess policy (Action:*, Resource:*) → attaches policy → prints credentials | 1. Create first account (ID 000000000001)<br>2. Sequential IDs (000000000002, etc.)<br>3. Admin user has full access<br>4. Credentials printed once | **DONE** |
| `hive admin account list` | — | Cluster must be running (NATS), master key must exist | Connects to NATS → IAMService.ListAccounts() → prints table with Account ID, Name, Status, Created | 1. List all accounts<br>2. Empty list (only global account) | **DONE** |
| `spx admin account create` | `--name` | Cluster must be running (NATS), master key must exist | Connects to NATS → CAS loop on `spinifex-account-counter:next_id` for sequential 12-digit ID → creates Account record in `spinifex-accounts` KV → creates `admin` user in new account → creates access key for admin → creates AdministratorAccess policy (Action:*, Resource:*) → attaches policy → prints credentials | 1. Create first account (ID 000000000001)<br>2. Sequential IDs (000000000002, etc.)<br>3. Admin user has full access<br>4. Credentials printed once | **DONE** |
| `spx admin account list` | — | Cluster must be running (NATS), master key must exist | Connects to NATS → IAMService.ListAccounts() → prints table with Account ID, Name, Status, Created | 1. List all accounts<br>2. Empty list (only global account) | **DONE** |
### Image Management
| Command | Flags | Prerequisites | Basic Logic | Test Cases | Status |
|---------|-------|---------------|-------------|------------|--------|
| `hive admin images import` | `--name` | Cluster must be running, image file must exist locally | Imports a local disk image (QCOW2) as an AMI → uploads to Predastore S3 → registers as available AMI | 1. Import valid QCOW2 image<br>2. Image appears in `describe-images` | **DONE** |
| `hive admin images list` | — | None | Lists available OS images that can be imported or downloaded | 1. List available images | **DONE** |
| `spx admin images import` | `--name` | Cluster must be running, image file must exist locally | Imports a local disk image (QCOW2) as an AMI → uploads to Predastore S3 → registers as available AMI | 1. Import valid QCOW2 image<br>2. Image appears in `describe-images` | **DONE** |
| `spx admin images list` | — | None | Lists available OS images that can be imported or downloaded | 1. List available images | **DONE** |
## AWS Commands
@@ -87,7 +87,7 @@ Operational commands for inspecting cluster state. These fan out NATS requests t
| `terminate-instances` | `--instance-ids`, `DeleteOnTermination` (per-volume flag, default true) | `--dry-run` | `run-instances` (instance must exist) | Gateway sends NATS to target node → daemon kills QEMU process → cleans up NBD mounts → deletes volumes with `DeleteOnTermination=true` via `volumeService.DeleteVolume()` (S3 cleanup of vol/, vol-efi/, vol-cloudinit/) → internal volumes (EFI, cloud-init) always cleaned up via `ebs.delete` NATS → volumes with `DeleteOnTermination=false` left in available state → state→terminated | 1. Terminate running instance<br>2. Terminate stopped instance<br>3. Terminate with DeleteOnTermination=true deletes volumes<br>4. Terminate with DeleteOnTermination=false preserves volumes<br>5. Terminate already-terminated (idempotent)<br>6. Internal volumes (EFI, cloud-init) always cleaned up<br>7. Invalid instance ID | **DONE** |
| `reboot-instances` | — | `--instance-ids`, `--dry-run` | `run-instances` (instance must be running) | Gateway sends NATS to target node → daemon issues QMP `system_reset` → instance reboots without stopping | 1. Reboot running instance<br>2. Reboot stopped instance (error)<br>3. Verify instance stays in running state after reboot | **NOT STARTED** (parser test exists) |
| `describe-instance-types` | `--filters` (capacity filter only) | `--instance-types`, `--max-results`, `--next-token`, `--dry-run`, all other filters | None | Gateway fans out NATS `ec2.DescribeInstanceTypes` to all nodes → each daemon reports supported types (t3.micro/small/medium/large) with vCPU/memory specs → gateway deduplicates and returns | 1. List all instance types<br>2. Filter by specific type<br>3. Filter with `capacity=true` shows available slots<br>4. Verify vCPU/memory specs match hardware | **DONE** |
| `modify-instance-attribute` | `--instance-id`, `--instance-type`, `--user-data` | `--disable-api-termination`, `--ebs-optimized`, `--source-dest-check`, `--instance-initiated-shutdown-behavior`, `--block-device-mappings`, `--groups`, `--ena-support`, `--sriov-net-support` | Instance must be stopped (in NATS KV) | Gateway validates input (exactly one attribute per call, instance ID format) → NATS `ec2.ModifyInstanceAttribute` with `hive-workers` queue group → daemon loads stopped instance from JetStream KV → applies attribute change → writes back to KV → returns `{}` on success. **InstanceType**: updates vm.InstanceType, Config, and Instance fields; clears StateReason (enables recovery from instance-type-missing bug). **UserData**: stores decoded content in vm.UserData and re-encodes to base64 for RunInstancesInput (cloud-init on next start). No instance type pre-validation (matches AWS — invalid types accepted, fail at StartInstances time). | 1. Change instance type while stopped<br>2. Change user data while stopped<br>3. Modify running instance (error: NotFound — running instances not in KV)<br>4. Instance not found (error: InvalidInstanceID.NotFound)<br>5. Instance not stopped (error: IncorrectInstanceState)<br>6. Invalid instance type accepted (fails on start with InsufficientInstanceCapacity)<br>7. StateReason cleared on type change (recovery from capacity-unavailable)<br>8. Missing/malformed instance ID (error: InvalidInstanceID.Malformed)<br>9. No attribute set (error: InvalidParameterValue)<br>10. Multiple attributes in one call (error: InvalidParameterValue) | **DONE** |
| `modify-instance-attribute` | `--instance-id`, `--instance-type`, `--user-data` | `--disable-api-termination`, `--ebs-optimized`, `--source-dest-check`, `--instance-initiated-shutdown-behavior`, `--block-device-mappings`, `--groups`, `--ena-support`, `--sriov-net-support` | Instance must be stopped (in NATS KV) | Gateway validates input (exactly one attribute per call, instance ID format) → NATS `ec2.ModifyInstanceAttribute` with `spinifex-workers` queue group → daemon loads stopped instance from JetStream KV → applies attribute change → writes back to KV → returns `{}` on success. **InstanceType**: updates vm.InstanceType, Config, and Instance fields; clears StateReason (enables recovery from instance-type-missing bug). **UserData**: stores decoded content in vm.UserData and re-encodes to base64 for RunInstancesInput (cloud-init on next start). No instance type pre-validation (matches AWS — invalid types accepted, fail at StartInstances time). | 1. Change instance type while stopped<br>2. Change user data while stopped<br>3. Modify running instance (error: NotFound — running instances not in KV)<br>4. Instance not found (error: InvalidInstanceID.NotFound)<br>5. Instance not stopped (error: IncorrectInstanceState)<br>6. Invalid instance type accepted (fails on start with InsufficientInstanceCapacity)<br>7. StateReason cleared on type change (recovery from capacity-unavailable)<br>8. Missing/malformed instance ID (error: InvalidInstanceID.Malformed)<br>9. No attribute set (error: InvalidParameterValue)<br>10. Multiple attributes in one call (error: InvalidParameterValue) | **DONE** |
| `get-console-output` | `--instance-id` | `--latest` (always returns latest), `--dry-run` | Instance must be running on a node | Gateway sends NATS `ec2.{instanceId}.GetConsoleOutput` (per-instance topic, routed to owning node) → daemon reads console log file from disk → returns last 64KB base64-encoded with timestamp. Always available regardless of serial console access setting (matches AWS behavior). | 1. Get output from running instance<br>2. Empty log file returns empty output<br>3. Instance not found (error: InvalidInstanceID.NotFound) | **DONE** |
| `monitor-instances` | — | `--instance-ids` | Instance must exist | Enable basic monitoring (CPU, disk, network) → store metrics in NATS KV → return monitoring state | 1. Enable monitoring<br>2. Verify monitoring state in describe-instances | **NOT STARTED** |
| `unmonitor-instances` | — | `--instance-ids` | Instance must exist | Disable detailed monitoring → revert to basic monitoring → return monitoring state | 1. Disable monitoring<br>2. Verify monitoring state reverts in describe-instances | **NOT STARTED** |
@@ -121,7 +121,7 @@ Operational commands for inspecting cluster state. These fan out NATS requests t
|---------|-------------------|---------------|---------------|-------------|------------|--------|
| `describe-volumes` | `--volume-ids` (fast-path lookup), `DeleteOnTermination` (from persisted VolumeMetadata) | `--filters`, `--max-results`, `--next-token`, `--dry-run` | None | NATS `ec2.DescribeVolumes` → daemon queries viperblock for volume metadata → returns volume list with state, size, attachments, type, DeleteOnTermination flag | 1. List all volumes<br>2. Filter by volume ID<br>3. Filter by attachment state<br>4. Non-existent volume returns empty<br>5. DeleteOnTermination reflects persisted value | **DONE** |
| `modify-volume` | `--volume-id`, `--size`, `--volume-type`, `--iops` | `--throughput`, `--dry-run`, `--multi-attach-enabled` | Volume must exist | NATS `ec2.ModifyVolume` → daemon sends resize request to viperblock → NBD does not support live resize, instance must be stopped → returns modification state | 1. Increase volume size<br>2. Modify volume type<br>3. Decrease size (error - not supported)<br>4. Modify attached volume (requires stop/start) | **DONE** |
| `create-volume` | `--size`, `--availability-zone`, `--volume-type` (gp3 only), `--snapshot-id` (creates volume from snapshot) | `--iops` (hardcoded 3000), `--encrypted` (hardcoded false), `--throughput`, `--tag-specifications` | Valid AZ configured via `hive init` | Gateway validates input → NATS `ec2.CreateVolume` → daemon generates vol-ID via viperblock → creates volume (empty or from snapshot) of specified size → persists config.json to Predastore S3 → returns vol-ID with state=available | 1. Create 80GB gp3 volume<br>2. Boundary sizes (1 GiB min, 16384 GiB max)<br>3. Invalid AZ (error)<br>4. Verify volume in describe-volumes<br>5. Unsupported volume type (error - only gp3)<br>6. Size out of range (error)<br>7. Create from snapshot | **DONE** |
| `create-volume` | `--size`, `--availability-zone`, `--volume-type` (gp3 only), `--snapshot-id` (creates volume from snapshot) | `--iops` (hardcoded 3000), `--encrypted` (hardcoded false), `--throughput`, `--tag-specifications` | Valid AZ configured via `spinifex init` | Gateway validates input → NATS `ec2.CreateVolume` → daemon generates vol-ID via viperblock → creates volume (empty or from snapshot) of specified size → persists config.json to Predastore S3 → returns vol-ID with state=available | 1. Create 80GB gp3 volume<br>2. Boundary sizes (1 GiB min, 16384 GiB max)<br>3. Invalid AZ (error)<br>4. Verify volume in describe-volumes<br>5. Unsupported volume type (error - only gp3)<br>6. Size out of range (error)<br>7. Create from snapshot | **DONE** |
| `delete-volume` | `--volume-id` | `--dry-run` | Volume must exist and be detached (state=available) | Gateway validates vol- prefix → NATS `ec2.DeleteVolume` → daemon confirms state=available and no AttachedInstance → NATS `ebs.delete` to viperblockd (stops nbdkit/WAL) → deletes S3 objects under vol-id/, vol-id-efi/, vol-id-cloudinit/ → returns success | 1. Delete detached volume<br>2. Delete attached volume (error: VolumeInUse)<br>3. Delete non-existent volume (error: InvalidVolume.NotFound)<br>4. Verify volume gone from describe-volumes<br>5. Malformed volume ID (error: InvalidVolumeID.Malformed)<br>6. Double delete (idempotent NotFound) | **DONE** |
| `attach-volume` | `--volume-id`, `--instance-id`, `--device` (optional, auto-assigns `/dev/sd[f-p]`) | `--dry-run` | Volume must exist (available), instance must exist (running) | Gateway sends to `ec2.cmd.{instanceId}` → daemon validates volume (Predastore) → `ebs.mount` via NATS (viperblock starts NBD server) → QMP `blockdev-add` (nbd-{volId}) → QMP `device_add` (virtio-blk-pci, vdisk-{volId}) → three-phase rollback on failure → update EBSRequests + BlockDeviceMappings → persist to JetStream + Predastore → respond with VolumeAttachment | 1. Attach volume to running instance<br>2. Auto-assign device name<br>3. Attach already-attached volume (VolumeInUse)<br>4. Attach to non-existent instance (InvalidInstanceID.NotFound)<br>5. Attach to stopped instance (IncorrectInstanceState)<br>6. Volume not found (InvalidVolume.NotFound)<br>7. All device slots full (AttachmentLimitExceeded)<br>8. Volume persists across stop/start | **DONE** |
| `detach-volume` | `--volume-id`, `--instance-id` (optional, resolved via DescribeVolumes), `--device` (optional cross-check), `--force` | `--dry-run` | Volume must be attached, instance must be running | Gateway resolves InstanceId if omitted (via DescribeVolumes) → sends to `ec2.cmd.{instanceId}` → daemon validates (running, attached, not boot/EFI/CloudInit, device match) → three-phase hot-unplug: QMP `device_del` (force continues on failure) → QMP `blockdev-del` (abort if fails, preserves state to prevent double-attach) → `ebs.unmount` via NATS (best-effort) → remove from EBSRequests + BlockDeviceMappings → update volume metadata to available → persist state → respond with VolumeAttachment (state=detaching) | 1. Detach with explicit InstanceId<br>2. Detach without InstanceId (gateway resolution)<br>3. Detach with correct --device cross-check<br>4. Missing VolumeId (InvalidParameterValue)<br>5. Volume not attached (IncorrectState)<br>6. Nonexistent volume (InvalidVolume.NotFound)<br>7. Nonexistent instance (InvalidInstanceID.NotFound)<br>8. Instance not running (IncorrectInstanceState)<br>9. Device mismatch (InvalidParameterValue)<br>10. Boot volume protection (OperationNotPermitted)<br>11. Force flag (continues past device_del failure)<br>12. Volume reusability (re-attach after detach) | **DONE** |
@@ -150,8 +150,8 @@ Operational commands for inspecting cluster state. These fan out NATS requests t
| Command | Implemented Flags | Missing Flags | Prerequisites | Basic Logic | Test Cases | Status |
|---------|-------------------|---------------|---------------|-------------|------------|--------|
| `describe-regions` | *(returns configured region, endpoint, opt-in status from config — input params ignored)* | `--region-names`, `--filters`, `--all-regions`, `--dry-run` | None | Return configured region from hive init config with Endpoint and OptInStatus → local-only response, no NATS | 1. List all regions<br>2. Filter by region name<br>3. Verify endpoint URL returned<br>4. Verify OptInStatus returned | **DONE** |
| `describe-availability-zones` | *(returns configured AZ, region, zone ID, state, opt-in status from config — input params ignored)* | `--zone-names`, `--filters`, `--all-availability-zones` | None | Return configured AZ from hive init config with zone ID, state, group name, network border group → local-only response, no NATS | 1. List all AZs<br>2. Filter by zone name<br>3. Verify zone state is available<br>4. Verify region name matches config | **DONE** |
| `describe-regions` | *(returns configured region, endpoint, opt-in status from config — input params ignored)* | `--region-names`, `--filters`, `--all-regions`, `--dry-run` | None | Return configured region from spinifex init config with Endpoint and OptInStatus → local-only response, no NATS | 1. List all regions<br>2. Filter by region name<br>3. Verify endpoint URL returned<br>4. Verify OptInStatus returned | **DONE** |
| `describe-availability-zones` | *(returns configured AZ, region, zone ID, state, opt-in status from config — input params ignored)* | `--zone-names`, `--filters`, `--all-availability-zones` | None | Return configured AZ from spinifex init config with zone ID, state, group name, network border group → local-only response, no NATS | 1. List all AZs<br>2. Filter by zone name<br>3. Verify zone state is available<br>4. Verify region name matches config | **DONE** |
### EC2 - Account Attributes
@@ -165,12 +165,12 @@ Persistence layer works (NATS JetStream KV), but stored values are not yet enfor
| Command | Implemented Flags | Missing Flags | Prerequisites | Basic Logic | Test Cases | Status |
|---------|-------------------|---------------|---------------|-------------|------------|--------|
| `enable-ebs-encryption-by-default` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.EnableEbsEncryptionByDefault` with `hive-workers` queue group → daemon stores `EbsEncryptionByDefault=true` in JetStream KV (`hive-ec2-account-settings` bucket) → return `EbsEncryptionByDefault=true`. Enforcement deferred: stored value not yet checked by CreateVolume/CreateSnapshot. | 1. Enable encryption<br>2. Verify via get | **STARTED** (enforcement pending) |
| `disable-ebs-encryption-by-default` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.DisableEbsEncryptionByDefault` with `hive-workers` queue group → daemon stores `EbsEncryptionByDefault=false` in JetStream KV → return `EbsEncryptionByDefault=false`. | 1. Disable encryption<br>2. Verify via get | **STARTED** (enforcement pending) |
| `get-ebs-encryption-by-default` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.GetEbsEncryptionByDefault` with `hive-workers` queue group → daemon reads `EbsEncryptionByDefault` from JetStream KV → return current state. | 1. Get default state<br>2. Verify matches last enable/disable | **STARTED** (enforcement pending) |
| `enable-serial-console-access` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.EnableSerialConsoleAccess` with `hive-workers` queue group → daemon stores `SerialConsoleAccessEnabled=true` in JetStream KV (`hive-ec2-account-settings` bucket) → return enabled=true. Stored for future interactive serial console support (not currently enforced by any operation). | 1. Enable access<br>2. Verify via get | **STARTED** (enforcement pending) |
| `disable-serial-console-access` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.DisableSerialConsoleAccess` with `hive-workers` queue group → daemon stores `SerialConsoleAccessEnabled=false` in JetStream KV → return enabled=false. Stored for future interactive serial console support (not currently enforced by any operation). | 1. Disable access<br>2. Verify via get | **STARTED** (enforcement pending) |
| `get-serial-console-access-status` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.GetSerialConsoleAccessStatus` with `hive-workers` queue group → daemon reads `SerialConsoleAccessEnabled` from JetStream KV → return current state. | 1. Get current status<br>2. Verify matches last enable/disable | **DONE** |
| `enable-ebs-encryption-by-default` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.EnableEbsEncryptionByDefault` with `spinifex-workers` queue group → daemon stores `EbsEncryptionByDefault=true` in JetStream KV (`spinifex-ec2-account-settings` bucket) → return `EbsEncryptionByDefault=true`. Enforcement deferred: stored value not yet checked by CreateVolume/CreateSnapshot. | 1. Enable encryption<br>2. Verify via get | **STARTED** (enforcement pending) |
| `disable-ebs-encryption-by-default` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.DisableEbsEncryptionByDefault` with `spinifex-workers` queue group → daemon stores `EbsEncryptionByDefault=false` in JetStream KV → return `EbsEncryptionByDefault=false`. | 1. Disable encryption<br>2. Verify via get | **STARTED** (enforcement pending) |
| `get-ebs-encryption-by-default` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.GetEbsEncryptionByDefault` with `spinifex-workers` queue group → daemon reads `EbsEncryptionByDefault` from JetStream KV → return current state. | 1. Get default state<br>2. Verify matches last enable/disable | **STARTED** (enforcement pending) |
| `enable-serial-console-access` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.EnableSerialConsoleAccess` with `spinifex-workers` queue group → daemon stores `SerialConsoleAccessEnabled=true` in JetStream KV (`spinifex-ec2-account-settings` bucket) → return enabled=true. Stored for future interactive serial console support (not currently enforced by any operation). | 1. Enable access<br>2. Verify via get | **STARTED** (enforcement pending) |
| `disable-serial-console-access` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.DisableSerialConsoleAccess` with `spinifex-workers` queue group → daemon stores `SerialConsoleAccessEnabled=false` in JetStream KV → return enabled=false. Stored for future interactive serial console support (not currently enforced by any operation). | 1. Disable access<br>2. Verify via get | **STARTED** (enforcement pending) |
| `get-serial-console-access-status` | *(no flags needed)* | `--dry-run` | None | Gateway validates input → NATS `ec2.GetSerialConsoleAccessStatus` with `spinifex-workers` queue group → daemon reads `SerialConsoleAccessEnabled` from JetStream KV → return current state. | 1. Get current status<br>2. Verify matches last enable/disable | **DONE** |
| `enable-snapshot-block-public-access` | — | `--state` | None | Store snapshot block public access state in JetStream KV | 1. Enable with block-all-sharing<br>2. Enable with block-new-sharing | **NOT STARTED** (enforcement pending) |
| `disable-snapshot-block-public-access` | — | `--dry-run` | None | Clear snapshot block public access state in JetStream KV | 1. Disable access | **NOT STARTED** (enforcement pending) |
| `get-snapshot-block-public-access-state` | — | `--dry-run` | None | Read snapshot block public access state from JetStream KV | 1. Get current state | **NOT STARTED** (enforcement pending) |
@@ -182,13 +182,13 @@ Persistence layer works (NATS JetStream KV), but stored values are not yet enfor
### EC2 - Egress-Only Internet Gateway
Gateway routing and KV CRUD are wired up but no OVN/OVS integration exists. EIGWs are stored in `hive-eigw` KV bucket but have no effect on network topology (no vpcd events published, unlike IGW which publishes `vpc.igw-attach`/`vpc.igw-detach`).
Gateway routing and KV CRUD are wired up but no OVN/OVS integration exists. EIGWs are stored in `spinifex-eigw` KV bucket but have no effect on network topology (no vpcd events published, unlike IGW which publishes `vpc.igw-attach`/`vpc.igw-detach`).
| Command | Implemented Flags | Missing Flags | Prerequisites | Basic Logic | Test Cases | Status |
|---------|-------------------|---------------|---------------|-------------|------------|--------|
| `create-egress-only-internet-gateway` | `--vpc-id`, `--tag-specifications` | `--client-token`, `--dry-run` | VPC must exist | Gateway validates VpcId → NATS `ec2.CreateEgressOnlyInternetGateway` → daemon generates eigw-ID → creates EgressOnlyIGWRecord in `hive-eigw` KV bucket with state=attached (always attached at creation, unlike IGW) → returns EgressOnlyInternetGateway with attachment | 1. Create with valid VpcId<br>2. Missing VpcId (error: MissingParameter)<br>3. Create with inline tags<br>4. Verify ID format eigw-{16hex} | **STARTED** (KV only, no OVN) |
| `delete-egress-only-internet-gateway` | `--egress-only-internet-gateway-id` | `--dry-run` | EIGW must exist | NATS `ec2.DeleteEgressOnlyInternetGateway` → daemon verifies EIGW exists in KV → deletes from `hive-eigw` KV → returns ReturnCode=true. No detach required (unlike IGW). | 1. Delete existing EIGW<br>2. Delete non-existent EIGW (error)<br>3. Missing ID (error: MissingParameter) | **STARTED** (KV only, no OVN) |
| `describe-egress-only-internet-gateways` | `--egress-only-internet-gateway-ids` | `--filters`, `--max-results`, `--next-token`, `--dry-run` | None | NATS `ec2.DescribeEgressOnlyInternetGateways` → daemon lists all keys from `hive-eigw` KV bucket → filters by ID if specified → always includes Attachments array → returns list | 1. Describe all EIGWs<br>2. Filter by specific ID<br>3. Non-existent ID returns empty list | **STARTED** (KV only, no OVN) |
| `create-egress-only-internet-gateway` | `--vpc-id`, `--tag-specifications` | `--client-token`, `--dry-run` | VPC must exist | Gateway validates VpcId → NATS `ec2.CreateEgressOnlyInternetGateway` → daemon generates eigw-ID → creates EgressOnlyIGWRecord in `spinifex-eigw` KV bucket with state=attached (always attached at creation, unlike IGW) → returns EgressOnlyInternetGateway with attachment | 1. Create with valid VpcId<br>2. Missing VpcId (error: MissingParameter)<br>3. Create with inline tags<br>4. Verify ID format eigw-{16hex} | **STARTED** (KV only, no OVN) |
| `delete-egress-only-internet-gateway` | `--egress-only-internet-gateway-id` | `--dry-run` | EIGW must exist | NATS `ec2.DeleteEgressOnlyInternetGateway` → daemon verifies EIGW exists in KV → deletes from `spinifex-eigw` KV → returns ReturnCode=true. No detach required (unlike IGW). | 1. Delete existing EIGW<br>2. Delete non-existent EIGW (error)<br>3. Missing ID (error: MissingParameter) | **STARTED** (KV only, no OVN) |
| `describe-egress-only-internet-gateways` | `--egress-only-internet-gateway-ids` | `--filters`, `--max-results`, `--next-token`, `--dry-run` | None | NATS `ec2.DescribeEgressOnlyInternetGateways` → daemon lists all keys from `spinifex-eigw` KV bucket → filters by ID if specified → always includes Attachments array → returns list | 1. Describe all EIGWs<br>2. Filter by specific ID<br>3. Non-existent ID returns empty list | **STARTED** (KV only, no OVN) |
### EC2 - Placement Groups
@@ -254,19 +254,19 @@ Gateway routing and KV CRUD are wired up but no OVN/OVS integration exists. EIGW
### EC2 - VPC Networking (Core)
Requires OVN/OVS (`apt install openvswitch-switch ovn-host`). VPC/Subnet/ENI CRUD stores metadata in NATS KV and publishes events to vpcd (the network topology daemon) which translates to OVN logical switches, ports, and routers. Single AZ for Hive v1. IPAM uses CAS-based allocation from NATS KV (`hive-vpc-ipam` bucket).
Requires OVN/OVS (`apt install openvswitch-switch ovn-host`). VPC/Subnet/ENI CRUD stores metadata in NATS KV and publishes events to vpcd (the network topology daemon) which translates to OVN logical switches, ports, and routers. Single AZ for Spinifex v1. IPAM uses CAS-based allocation from NATS KV (`spinifex-vpc-ipam` bucket).
| Command | Implemented Flags | Missing Flags | Prerequisites | Basic Logic | Test Cases | Status |
|---------|-------------------|---------------|---------------|-------------|------------|--------|
| `create-vpc` | `--cidr-block`, `--tag-specifications` | `--instance-tenancy`, `--dry-run` | None | Gateway validates CidrBlock (required, valid CIDR, /16–/28 prefix) → NATS `ec2.CreateVpc` → daemon allocates unique VNI from `hive-vpc-vni-counter` KV → generates vpc-ID → stores VPCRecord in `hive-vpc-vpcs` KV → publishes `vpc.create` event to vpcd (creates OVN logical switch) → returns VPC with state=available | 1. Create VPC with /16 CIDR<br>2. Invalid CIDR format (error: InvalidVpcRange)<br>3. CIDR prefix outside /16–/28 (error)<br>4. Verify in describe-vpcs<br>5. Tags applied at creation | **DONE** |
| `delete-vpc` | `--vpc-id` | `--dry-run` | VPC must be empty (no subnets) | Gateway validates VpcId → NATS `ec2.DeleteVpc` → daemon checks for dependent subnets in `hive-vpc-subnets` KV → returns DependencyViolation if subnets exist → deletes from `hive-vpc-vpcs` KV → publishes `vpc.delete` event to vpcd (removes OVN resources) | 1. Delete empty VPC<br>2. Delete VPC with subnets (DependencyViolation)<br>3. Delete non-existent VPC (error) | **DONE** |
| `describe-vpcs` | `--vpc-ids` | `--filters`, `--max-results`, `--dry-run` | None | NATS `ec2.DescribeVpcs` → daemon lists all keys from `hive-vpc-vpcs` KV → filters by VPC IDs if specified → returns error for non-existent requested IDs → returns VPC list with CIDR, state, CIDR associations | 1. List all VPCs<br>2. Filter by VPC ID<br>3. Non-existent VPC ID returns error | **DONE** |
| `create-vpc` | `--cidr-block`, `--tag-specifications` | `--instance-tenancy`, `--dry-run` | None | Gateway validates CidrBlock (required, valid CIDR, /16–/28 prefix) → NATS `ec2.CreateVpc` → daemon allocates unique VNI from `spinifex-vpc-vni-counter` KV → generates vpc-ID → stores VPCRecord in `spinifex-vpc-vpcs` KV → publishes `vpc.create` event to vpcd (creates OVN logical switch) → returns VPC with state=available | 1. Create VPC with /16 CIDR<br>2. Invalid CIDR format (error: InvalidVpcRange)<br>3. CIDR prefix outside /16–/28 (error)<br>4. Verify in describe-vpcs<br>5. Tags applied at creation | **DONE** |
| `delete-vpc` | `--vpc-id` | `--dry-run` | VPC must be empty (no subnets) | Gateway validates VpcId → NATS `ec2.DeleteVpc` → daemon checks for dependent subnets in `spinifex-vpc-subnets` KV → returns DependencyViolation if subnets exist → deletes from `spinifex-vpc-vpcs` KV → publishes `vpc.delete` event to vpcd (removes OVN resources) | 1. Delete empty VPC<br>2. Delete VPC with subnets (DependencyViolation)<br>3. Delete non-existent VPC (error) | **DONE** |
| `describe-vpcs` | `--vpc-ids` | `--filters`, `--max-results`, `--dry-run` | None | NATS `ec2.DescribeVpcs` → daemon lists all keys from `spinifex-vpc-vpcs` KV → filters by VPC IDs if specified → returns error for non-existent requested IDs → returns VPC list with CIDR, state, CIDR associations | 1. List all VPCs<br>2. Filter by VPC ID<br>3. Non-existent VPC ID returns error | **DONE** |
| `modify-vpc-attribute` | — | `--vpc-id`, `--enable-dns-support`, `--enable-dns-hostnames` | VPC must exist | NATS `ec2.ModifyVpcAttribute` → daemon updates VPC attribute in KV → return success | 1. Enable DNS support<br>2. Enable DNS hostnames<br>3. Missing VPC ID (error) | **NOT STARTED** |
| `associate-vpc-cidr-block` | — | `--vpc-id`, `--cidr-block` | VPC must exist | NATS `ec2.AssociateVpcCidrBlock` → daemon adds secondary CIDR to VPC metadata → return association | 1. Add secondary CIDR<br>2. Overlapping CIDR (error)<br>3. Max CIDR blocks exceeded (error) | **NOT STARTED** |
| `disassociate-vpc-cidr-block` | — | `--association-id` | Association must exist | NATS `ec2.DisassociateVpcCidrBlock` → daemon removes secondary CIDR from VPC → return success | 1. Remove secondary CIDR<br>2. Remove primary CIDR (error) | **NOT STARTED** |
| `create-subnet` | `--vpc-id`, `--cidr-block`, `--availability-zone`, `--tag-specifications` | `--dry-run` | VPC must exist | Gateway validates VpcId + CidrBlock (required, valid CIDR, /16–/28 prefix) → NATS `ec2.CreateSubnet` → daemon verifies parent VPC exists → validates subnet CIDR is within VPC CIDR range → checks for overlapping subnets in same VPC → calculates available IPs (total hosts - 5 AWS-reserved: .0/.1/.2/.3/.255) → generates subnet-ID → stores SubnetRecord in `hive-vpc-subnets` KV → publishes `vpc.create-subnet` event to vpcd → defaults AZ from config if omitted | 1. Create subnet within VPC CIDR<br>2. Subnet CIDR outside VPC range (error: InvalidSubnetRange)<br>3. Overlapping subnet CIDRs (error: InvalidSubnetConflict)<br>4. CIDR prefix outside /16–/28 (error)<br>5. Missing VPC or CIDR (error: MissingParameter) | **DONE** |
| `delete-subnet` | `--subnet-id` | `--dry-run` | Subnet must exist | NATS `ec2.DeleteSubnet` → daemon verifies subnet exists → deletes from `hive-vpc-subnets` KV → publishes `vpc.delete-subnet` event to vpcd | 1. Delete existing subnet<br>2. Delete non-existent subnet (error) | **DONE** |
| `describe-subnets` | `--subnet-ids`, `--filters` (vpc-id) | `--max-results`, `--dry-run` | None | NATS `ec2.DescribeSubnets` → daemon lists all keys from `hive-vpc-subnets` KV → applies vpc-id filter if present → filters by subnet IDs if specified → recalculates available IPs from CIDR → returns error for non-existent requested IDs | 1. List all subnets<br>2. Filter by VPC ID<br>3. Filter by subnet ID<br>4. Non-existent subnet returns error | **DONE** |
| `create-subnet` | `--vpc-id`, `--cidr-block`, `--availability-zone`, `--tag-specifications` | `--dry-run` | VPC must exist | Gateway validates VpcId + CidrBlock (required, valid CIDR, /16–/28 prefix) → NATS `ec2.CreateSubnet` → daemon verifies parent VPC exists → validates subnet CIDR is within VPC CIDR range → checks for overlapping subnets in same VPC → calculates available IPs (total hosts - 5 AWS-reserved: .0/.1/.2/.3/.255) → generates subnet-ID → stores SubnetRecord in `spinifex-vpc-subnets` KV → publishes `vpc.create-subnet` event to vpcd → defaults AZ from config if omitted | 1. Create subnet within VPC CIDR<br>2. Subnet CIDR outside VPC range (error: InvalidSubnetRange)<br>3. Overlapping subnet CIDRs (error: InvalidSubnetConflict)<br>4. CIDR prefix outside /16–/28 (error)<br>5. Missing VPC or CIDR (error: MissingParameter) | **DONE** |
| `delete-subnet` | `--subnet-id` | `--dry-run` | Subnet must exist | NATS `ec2.DeleteSubnet` → daemon verifies subnet exists → deletes from `spinifex-vpc-subnets` KV → publishes `vpc.delete-subnet` event to vpcd | 1. Delete existing subnet<br>2. Delete non-existent subnet (error) | **DONE** |
| `describe-subnets` | `--subnet-ids`, `--filters` (vpc-id) | `--max-results`, `--dry-run` | None | NATS `ec2.DescribeSubnets` → daemon lists all keys from `spinifex-vpc-subnets` KV → applies vpc-id filter if present → filters by subnet IDs if specified → recalculates available IPs from CIDR → returns error for non-existent requested IDs | 1. List all subnets<br>2. Filter by VPC ID<br>3. Filter by subnet ID<br>4. Non-existent subnet returns error | **DONE** |
| `modify-subnet-attribute` | — | `--subnet-id`, `--map-public-ip-on-launch`, `--assign-ipv6-address-on-creation` | Subnet must exist | NATS `ec2.ModifySubnetAttribute` → daemon updates subnet attribute in KV → return success | 1. Enable auto-assign public IP<br>2. Missing subnet ID (error) | **NOT STARTED** |
| `associate-subnet-cidr-block` | — | `--subnet-id`, `--ipv6-cidr-block` | Subnet must exist | NATS `ec2.AssociateSubnetCidrBlock` → daemon adds IPv6 CIDR to subnet → return association | 1. Add IPv6 CIDR<br>2. Missing subnet ID (error) | **NOT STARTED** |
| `disassociate-subnet-cidr-block` | — | `--association-id` | Association must exist | NATS `ec2.DisassociateSubnetCidrBlock` → daemon removes IPv6 CIDR from subnet → return success | 1. Remove IPv6 CIDR<br>2. Invalid association (error) | **NOT STARTED** |
@@ -277,11 +277,11 @@ Requires OVN/OVS (`apt install openvswitch-switch ovn-host`). VPC/Subnet/ENI CRU
| `authorize-security-group-egress` | — | `--group-id`, `--protocol`, `--port`, `--cidr` | SG must exist | Add outbound rule → create OVS OpenFlow rule → persist to metadata | 1. Allow HTTPS outbound<br>2. Restrict to specific CIDR | **NOT STARTED** |
| `revoke-security-group-ingress` | — | `--group-id`, `--protocol`, `--port`, `--cidr` | SG must exist, rule must exist | Remove inbound rule → delete OVS OpenFlow rule → update metadata | 1. Revoke existing rule<br>2. Revoke non-existent rule (error) | **NOT STARTED** |
| `revoke-security-group-egress` | — | `--group-id`, `--protocol`, `--port`, `--cidr` | SG must exist, rule must exist | Remove outbound rule → delete OVS OpenFlow rule → update metadata | 1. Revoke existing rule<br>2. Revoke non-existent rule (error) | **NOT STARTED** |
| `create-internet-gateway` | `--tag-specifications` | `--dry-run` | None | NATS `ec2.CreateInternetGateway` → daemon generates igw-ID → creates IGWRecord in `hive-igw` KV bucket with state=available (not attached) → returns InternetGateway with empty Attachments | 1. Create IGW<br>2. Verify in describe-internet-gateways<br>3. Tags applied at creation | **DONE** |
| `create-internet-gateway` | `--tag-specifications` | `--dry-run` | None | NATS `ec2.CreateInternetGateway` → daemon generates igw-ID → creates IGWRecord in `spinifex-igw` KV bucket with state=available (not attached) → returns InternetGateway with empty Attachments | 1. Create IGW<br>2. Verify in describe-internet-gateways<br>3. Tags applied at creation | **DONE** |
| `attach-internet-gateway` | `--internet-gateway-id`, `--vpc-id` | `--dry-run` | IGW and VPC must exist | NATS `ec2.AttachInternetGateway` → daemon validates IGW exists and is not already attached (ResourceAlreadyAssociated) → sets VpcId on record → state=attached → publishes `vpc.igw-attach` event to vpcd (creates OVN external switch, gateway port, SNAT rules) | 1. Attach IGW to VPC<br>2. Attach already-attached IGW (ResourceAlreadyAssociated)<br>3. Non-existent IGW (error)<br>4. Missing params (MissingParameter) | **DONE** |
| `detach-internet-gateway` | `--internet-gateway-id`, `--vpc-id` | `--dry-run` | IGW must be attached to specified VPC | NATS `ec2.DetachInternetGateway` → daemon validates IGW exists and is attached to specified VPC (GatewayNotAttached if wrong VPC) → clears VpcId → state=available → publishes `vpc.igw-detach` event to vpcd (removes OVN resources) | 1. Detach attached IGW<br>2. Detach from wrong VPC (GatewayNotAttached)<br>3. Detach unattached IGW (error) | **DONE** |
| `delete-internet-gateway` | `--internet-gateway-id` | `--dry-run` | IGW must be detached | NATS `ec2.DeleteInternetGateway` → daemon validates IGW exists and VpcId is empty (DependencyViolation if attached) → deletes from `hive-igw` KV | 1. Delete detached IGW<br>2. Delete attached IGW (DependencyViolation)<br>3. Delete non-existent (error) | **DONE** |
| `describe-internet-gateways` | `--internet-gateway-ids` | `--filters`, `--max-results`, `--dry-run` | None | NATS `ec2.DescribeInternetGateways` → daemon lists all keys from `hive-igw` KV → filters by IGW IDs if specified → returns list with Attachments array (if attached) | 1. List all IGWs<br>2. Filter by IGW ID<br>3. Verify attachment info | **DONE** |
| `delete-internet-gateway` | `--internet-gateway-id` | `--dry-run` | IGW must be detached | NATS `ec2.DeleteInternetGateway` → daemon validates IGW exists and VpcId is empty (DependencyViolation if attached) → deletes from `spinifex-igw` KV | 1. Delete detached IGW<br>2. Delete attached IGW (DependencyViolation)<br>3. Delete non-existent (error) | **DONE** |
| `describe-internet-gateways` | `--internet-gateway-ids` | `--filters`, `--max-results`, `--dry-run` | None | NATS `ec2.DescribeInternetGateways` → daemon lists all keys from `spinifex-igw` KV → filters by IGW IDs if specified → returns list with Attachments array (if attached) | 1. List all IGWs<br>2. Filter by IGW ID<br>3. Verify attachment info | **DONE** |
### EC2 - Route Tables
@@ -365,13 +365,13 @@ Requires OVN/OVS (`apt install openvswitch-switch ovn-host`). VPC/Subnet/ENI CRU
### EC2 - Network Interfaces
ENIs are managed via `hive-vpc-enis` KV bucket with CAS-based IPAM allocation from `hive-vpc-ipam`. ENIs are auto-created by `run-instances --subnet-id` and auto-deleted on termination. MAC addresses are deterministically generated from the ENI ID. Attach/detach are internal operations used by instance lifecycle — no standalone attach/detach API yet.
ENIs are managed via `spinifex-vpc-enis` KV bucket with CAS-based IPAM allocation from `spinifex-vpc-ipam`. ENIs are auto-created by `run-instances --subnet-id` and auto-deleted on termination. MAC addresses are deterministically generated from the ENI ID. Attach/detach are internal operations used by instance lifecycle — no standalone attach/detach API yet.
| Command | Implemented Flags | Missing Flags | Prerequisites | Basic Logic | Test Cases | Status |
|---------|-------------------|---------------|---------------|-------------|------------|--------|
| `create-network-interface` | `--subnet-id`, `--private-ip-address`, `--description`, `--tag-specifications` | `--groups`, `--dry-run` | Subnet must exist | Gateway validates SubnetId (required) → NATS `ec2.CreateNetworkInterface` → daemon verifies subnet exists in `hive-vpc-subnets` KV → if no PrivateIpAddress, allocates from IPAM pool (CAS-based, up to 5 retries) → generates eni-ID → generates deterministic MAC from ENI ID → stores ENIRecord in `hive-vpc-enis` KV → publishes `vpc.create-port` event to vpcd (creates OVN logical port) → returns NetworkInterface with status=available | 1. Create in subnet (auto-allocate IP)<br>2. Create with specific private IP<br>3. Missing subnet ID (MissingParameter)<br>4. Non-existent subnet (error)<br>5. Tags applied at creation | **DONE** |
| `delete-network-interface` | `--network-interface-id` | `--dry-run` | Must not be attached (status != in-use) | NATS `ec2.DeleteNetworkInterface` → daemon verifies ENI exists and status is not "in-use" (InvalidNetworkInterfaceInUse) → releases IP back to IPAM pool → deletes from `hive-vpc-enis` KV → publishes `vpc.delete-port` event to vpcd | 1. Delete detached ENI<br>2. Delete attached ENI (InvalidNetworkInterfaceInUse)<br>3. Delete non-existent (error) | **DONE** |
| `describe-network-interfaces` | `--network-interface-ids`, `--filters` (subnet-id, vpc-id, attachment.instance-id) | `--max-results`, `--dry-run` | None | NATS `ec2.DescribeNetworkInterfaces` → daemon lists all keys from `hive-vpc-enis` KV → applies filters (subnet-id, vpc-id, attachment.instance-id) → filters by ENI IDs if specified → returns error for non-existent requested IDs | 1. List all ENIs<br>2. Filter by subnet-id<br>3. Filter by vpc-id<br>4. Filter by attachment.instance-id<br>5. Non-existent ENI returns error | **DONE** |
| `create-network-interface` | `--subnet-id`, `--private-ip-address`, `--description`, `--tag-specifications` | `--groups`, `--dry-run` | Subnet must exist | Gateway validates SubnetId (required) → NATS `ec2.CreateNetworkInterface` → daemon verifies subnet exists in `spinifex-vpc-subnets` KV → if no PrivateIpAddress, allocates from IPAM pool (CAS-based, up to 5 retries) → generates eni-ID → generates deterministic MAC from ENI ID → stores ENIRecord in `spinifex-vpc-enis` KV → publishes `vpc.create-port` event to vpcd (creates OVN logical port) → returns NetworkInterface with status=available | 1. Create in subnet (auto-allocate IP)<br>2. Create with specific private IP<br>3. Missing subnet ID (MissingParameter)<br>4. Non-existent subnet (error)<br>5. Tags applied at creation | **DONE** |
| `delete-network-interface` | `--network-interface-id` | `--dry-run` | Must not be attached (status != in-use) | NATS `ec2.DeleteNetworkInterface` → daemon verifies ENI exists and status is not "in-use" (InvalidNetworkInterfaceInUse) → releases IP back to IPAM pool → deletes from `spinifex-vpc-enis` KV → publishes `vpc.delete-port` event to vpcd | 1. Delete detached ENI<br>2. Delete attached ENI (InvalidNetworkInterfaceInUse)<br>3. Delete non-existent (error) | **DONE** |
| `describe-network-interfaces` | `--network-interface-ids`, `--filters` (subnet-id, vpc-id, attachment.instance-id) | `--max-results`, `--dry-run` | None | NATS `ec2.DescribeNetworkInterfaces` → daemon lists all keys from `spinifex-vpc-enis` KV → applies filters (subnet-id, vpc-id, attachment.instance-id) → filters by ENI IDs if specified → returns error for non-existent requested IDs | 1. List all ENIs<br>2. Filter by subnet-id<br>3. Filter by vpc-id<br>4. Filter by attachment.instance-id<br>5. Non-existent ENI returns error | **DONE** |
| `attach-network-interface` | — | `--network-interface-id`, `--instance-id`, `--device-index` | ENI and instance must exist | Internal operation used by `run-instances --subnet-id`. Marks ENI as "in-use", sets instance attachment, generates attachment ID. No standalone API endpoint yet. | 1. Attach ENI to instance<br>2. Already attached (error)<br>3. Missing device index (error) | **NOT STARTED** (internal only) |
| `detach-network-interface` | — | `--attachment-id`, `--force` | ENI must be attached | Internal operation used by terminate-instances. Marks ENI as "available", clears attachment info. No standalone API endpoint yet. | 1. Detach ENI<br>2. Force detach<br>3. Not attached (error) | **NOT STARTED** (internal only) |
| `modify-network-interface-attribute` | — | `--network-interface-id`, `--description`, `--source-dest-check`, `--groups` | ENI must exist | NATS `ec2.ModifyNetworkInterfaceAttribute` → daemon updates ENI attributes in KV → return success | 1. Modify description<br>2. Toggle source/dest check<br>3. Update security groups | **NOT STARTED** |
@@ -409,7 +409,7 @@ ENIs are managed via `hive-vpc-enis` KV bucket with CAS-based IPAM allocation fr
### S3 (via Predastore)
Currently S3 operations are handled directly by Predastore. Consider moving control/data plane to Hive format for AWS gateway integration.
Currently S3 operations are handled directly by Predastore. Consider moving control/data plane to Spinifex format for AWS gateway integration.
| Command | Implemented Flags | Missing Flags | Prerequisites | Basic Logic | Test Cases | Status |
|---------|-------------------|---------------|---------------|-------------|------------|--------|
docs/DESIGN.md
+26 -26
View File
@@ -1,6 +1,6 @@
# Hive Architecture
# Spinifex Architecture
Hive is an AWS-compatible infrastructure platform for bare-metal, edge, and on-premise deployments. It provides EC2-compatible VM orchestration backed by QEMU/KVM, with storage provided by companion projects Viperblock (EBS) and Predastore (S3).
Spinifex is an AWS-compatible infrastructure platform for bare-metal, edge, and on-premise deployments. It provides EC2-compatible VM orchestration backed by QEMU/KVM, with storage provided by companion projects Viperblock (EBS) and Predastore (S3).
## High-Level Architecture
@@ -19,7 +19,7 @@ Hive is an AWS-compatible infrastructure platform for bare-metal, edge, and on-p
│ • EC2 Query Protocol parsing • Routes to service handlers │
│ • XML response generation • NATS client connection │
│ │
│ File: hive/services/awsgw/awsgw.go │
│ File: spinifex/services/awsgw/awsgw.go │
└─────────────────────────────────────────────────────────────────────────────┘
│
│ JSON over NATS
@@ -28,7 +28,7 @@ Hive is an AWS-compatible infrastructure platform for bare-metal, edge, and on-p
│ NATS Message Broker │
│ │
│ Topics: Queue Groups: │
│ • ec2.RunInstances • hive-workers (load balanced) │
│ • ec2.RunInstances • spinifex-workers (load balanced) │
│ • ec2.DescribeInstances • No queue (fan-out to all nodes) │
│ • ec2.cmd.{instanceID} (per-instance start/stop/terminate) │
│ • ebs.mount / ebs.unmount │
@@ -37,7 +37,7 @@ Hive is an AWS-compatible infrastructure platform for bare-metal, edge, and on-p
┌─────────────────┼─────────────────┐
▼ ▼ ▼
┌──────────────────────┐ ┌──────────────────────┐ ┌──────────────────────┐
│ Hive Daemon │ │ Hive Daemon │ │ Hive Daemon │
│ Spinifex Daemon │ │ Spinifex Daemon │ │ Spinifex Daemon │
│ (Node 1) │ │ (Node 2) │ │ (Node N) │
│ │ │ │ │ │
│ • NATS subscriber │ │ • NATS subscriber │ │ • NATS subscriber │
@@ -58,7 +58,7 @@ Hive is an AWS-compatible infrastructure platform for bare-metal, edge, and on-p
### 1. AWS SDK Request
Users interact with Hive using standard AWS SDKs or the AWS CLI by pointing to a custom endpoint:
Users interact with Spinifex using standard AWS SDKs or the AWS CLI by pointing to a custom endpoint:
```bash
aws --endpoint-url https://localhost:9999 --no-verify-ssl ec2 run-instances \
@@ -73,7 +73,7 @@ The AWS SDK formats this as an HTTP POST with:
### 2. AWS Gateway
The gateway (`hive/services/awsgw/awsgw.go:57-107`) is the entry point:
The gateway (`spinifex/services/awsgw/awsgw.go:57-107`) is the entry point:
```go
// awsgw.go:74 - Connect to NATS
@@ -89,7 +89,7 @@ gw := gateway.GatewayConfig{
log.Fatal(app.ListenTLS(nodeConfig.AWSGW.Host, nodeConfig.AWSGW.TLSCert, nodeConfig.AWSGW.TLSKey))
```
Request routing (`hive/gateway/gateway.go:125-156`):
Request routing (`spinifex/gateway/gateway.go:125-156`):
1. **Authentication**: SigV4 middleware validates AWS credentials (`gateway.go:104`)
2. **Service Detection**: Extracts service name (ec2, iam, account) from Authorization header (`gateway.go:158-186`)
@@ -109,7 +109,7 @@ case "iam":
### 3. EC2 Handler
The EC2 handler (`hive/gateway/ec2.go`) parses the Action parameter and delegates to specific handlers:
The EC2 handler (`spinifex/gateway/ec2.go`) parses the Action parameter and delegates to specific handlers:
```go
// ec2.go - Action routing
@@ -124,7 +124,7 @@ case "DescribeInstances":
### 4. NATS Messaging
The gateway communicates with daemons via NATS request/response (`hive/handlers/ec2/instance/service_nats.go:24-57`):
The gateway communicates with daemons via NATS request/response (`spinifex/handlers/ec2/instance/service_nats.go:24-57`):
```go
// service_nats.go:24-57
@@ -145,13 +145,13 @@ func (s *NATSInstanceService) RunInstances(input *ec2.RunInstancesInput) (*ec2.R
### 5. Daemon Processing
Daemons (`hive/daemon/daemon.go`) subscribe to NATS topics and handle requests:
Daemons (`spinifex/daemon/daemon.go`) subscribe to NATS topics and handle requests:
```go
// daemon.go:319 - Subscribe with queue group for load balancing
d.natsSubscriptions["ec2.RunInstances"], err = d.natsConn.QueueSubscribe(
"ec2.RunInstances",
"hive-workers", // Queue group - only one daemon handles each request
"spinifex-workers", // Queue group - only one daemon handles each request
d.handleEC2RunInstances,
)
@@ -162,7 +162,7 @@ d.natsSubscriptions["ec2.DescribeInstances"], err = d.natsConn.Subscribe(
)
```
**Queue Groups**: Topics subscribed with a queue group (`hive-workers`) are load-balanced - only one daemon handles each request. Topics without a queue group fan out to all daemons.
**Queue Groups**: Topics subscribed with a queue group (`spinifex-workers`) are load-balanced - only one daemon handles each request. Topics without a queue group fan out to all daemons.
### 6. VM Launch
@@ -225,19 +225,19 @@ type ResourceManager struct {
| Topic | Queue Group | Purpose |
|-------|-------------|---------|
| `ec2.RunInstances` | `hive-workers` | Launch new instances |
| `ec2.RunInstances` | `spinifex-workers` | Launch new instances |
| `ec2.DescribeInstances` | None (fan-out) | Query all nodes for instances |
| `ec2.cmd.{instanceID}` | None (owner only) | Per-instance commands (start/stop/terminate, attach/detach volume) |
| `ec2.CreateKeyPair` | `hive-workers` | Generate SSH keypair |
| `ec2.DescribeKeyPairs` | `hive-workers` | List SSH keypairs |
| `ec2.DescribeImages` | `hive-workers` | List AMIs |
| `ec2.CreateKeyPair` | `spinifex-workers` | Generate SSH keypair |
| `ec2.DescribeKeyPairs` | `spinifex-workers` | List SSH keypairs |
| `ec2.DescribeImages` | `spinifex-workers` | List AMIs |
| `ebs.mount` | - | Mount volume via Viperblock |
| `ebs.unmount` | - | Unmount volume |
| `hive.admin.{node}.health` | None | Node health checks |
| `spinifex.admin.{node}.health` | None | Node health checks |
### Multi-Node Aggregation
For operations that need data from all nodes (like `DescribeInstances`), the gateway uses inbox-based fan-out (`hive/gateway/ec2/instance/DescribeInstances.go`):
For operations that need data from all nodes (like `DescribeInstances`), the gateway uses inbox-based fan-out (`spinifex/gateway/ec2/instance/DescribeInstances.go`):
```go
// DescribeInstances.go:16-111
@@ -288,13 +288,13 @@ Object storage used for:
## Configuration
Cluster configuration (`hive/config/config.go`):
Cluster configuration (`spinifex/config/config.go`):
```go
type ClusterConfig struct {
Epoch uint64 // Incremented on config changes
Node string // This node's identifier
Version string // Hive version
Version string // Spinifex version
Nodes map[string]Config // Configuration for all nodes
}
@@ -312,8 +312,8 @@ type Config struct {
## File Structure
```
hive/
├── hive/
spinifex/
├── spinifex/
│ ├── services/
│ │ └── awsgw/
│ │ └── awsgw.go # AWS Gateway service entry point
@@ -340,7 +340,7 @@ hive/
│ └── qmp/
│ └── qmp.go # QEMU Machine Protocol client
└── cmd/
└── hive/
└── spinifex/
└── main.go # CLI entry point
```
@@ -351,8 +351,8 @@ hive/
1. Start NATS broker
2. Start Predastore (S3)
3. Start Viperblock (EBS)
4. Start Hive Gateway (`hive awsgw`)
5. Start Hive Daemon(s) (`hive daemon`)
4. Start Spinifex Gateway (`hive awsgw`)
5. Start Spinifex Daemon(s) (`hive daemon`)
### Testing with AWS CLI
docs/INSTALL_ORIGINAL.md
+159 -159
View File
@@ -1,4 +1,4 @@
# Hive Installation
# Spinifex Installation
Notes for development environment installation.
@@ -15,20 +15,20 @@ For the development preview, please use one of the supported versions above.
## Download
Create the base directory for the Hive development environment.
Create the base directory for the Spinifex development environment.
```bash
mkdir -p ~/Development/mulga/
cd ~/Development/mulga/
git clone https://github.com/mulgadc/hive.git
git clone https://github.com/mulgadc/spinifex.git
```
### Quick Install
To bootstrap all dependencies of Hive in one step (QEMU, Go, AWS CLI, OVN/OVS):
To bootstrap all dependencies of Spinifex in one step (QEMU, Go, AWS CLI, OVN/OVS):
```bash
sudo make -C hive quickinstall
sudo make -C spinifex quickinstall
```
Ensure Go is available in your `PATH` if not previously installed:
@@ -56,7 +56,7 @@ Confirm Go is correctly installed, and set in your $PATH.
go version
```
Hive provides AWS API/SDK layer functionality, which requires the AWS CLI tool to be installed to interface with the system.
Spinifex provides AWS API/SDK layer functionality, which requires the AWS CLI tool to be installed to interface with the system.
```bash
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
@@ -77,16 +77,16 @@ aws --version
Setup the dev environment and package dependencies on [viperblock](https://github.com/mulgadc/viperblock/) and [predastore](https://github.com/mulgadc/predastore/).
```bash
cd hive
cd spinifex
./scripts/clone-deps.sh # Clone viperblock + predastore repositories
./scripts/dev-setup.sh # Setup complete development environment
```
Once complete, confirm `./bin/hive` exists and is executable.
Once complete, confirm `./bin/spx` exists and is executable.
# Single Node Installation
For rapid development and testing, `hive` can be installed locally as a single node instance. Follow the instructions below for a complete working environment. For multi node installation, skip to [Multi-Node Installation](#multi-node-installation)
For rapid development and testing, `spx` can be installed locally as a single node instance. Follow the instructions below for a complete working environment. For multi node installation, skip to [Multi-Node Installation](#multi-node-installation)
## Setup OVN
@@ -96,31 +96,31 @@ OVN provides the virtual networking layer for VPC instances. This step configure
./scripts/setup-ovn.sh --management
```
This creates the `br-int` integration bridge, starts `ovn-controller`, starts the OVN central databases (NB DB + SB DB), configures Geneve tunnel endpoints, enables IP forwarding, and creates a sudoers rule so the Hive daemon can manage tap devices and OVS ports without running as root. Hive will not start without this step.
This creates the `br-int` integration bridge, starts `ovn-controller`, starts the OVN central databases (NB DB + SB DB), configures Geneve tunnel endpoints, enables IP forwarding, and creates a sudoers rule so the Spinifex daemon can manage tap devices and OVS ports without running as root. Spinifex will not start without this step.
## Init
When running Hive for the first time, run the init function to create the default directories for data, config files and layout required.
When running Spinifex for the first time, run the init function to create the default directories for data, config files and layout required.
Example single node installation to get started, this will create a new region `ap-southeast-2` and availability zone `ap-southeast-2a` on your local instance:
```bash
./bin/hive admin init --region ap-southeast-2 --az ap-southeast-2a --node node1 --nodes 1
./bin/spx admin init --region ap-southeast-2 --az ap-southeast-2a --node node1 --nodes 1
```
## Trust CA Certificate (Required)
Hive generates a local Certificate Authority (CA) during initialization. For AWS CLI and other tools to trust Hive services over HTTPS, you must add the CA certificate to your system's trust store.
Spinifex generates a local Certificate Authority (CA) during initialization. For AWS CLI and other tools to trust Spinifex services over HTTPS, you must add the CA certificate to your system's trust store.
```bash
sudo cp ~/hive/config/ca.pem /usr/local/share/ca-certificates/hive-ca.crt
sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates
```
Verify the certificate was added:
```bash
ls -la /usr/local/share/ca-certificates/hive-ca.crt
ls -la /usr/local/share/ca-certificates/spinifex-ca.crt
```
## Launch Services
@@ -134,7 +134,7 @@ Start the core services for development.
Set the AWS profile to use the default admin account created during init:
```bash
export AWS_PROFILE=hive
export AWS_PROFILE=spinifex
```
All subsequent `aws` CLI commands will use this account.
@@ -148,7 +148,7 @@ For first install, create or import an existing key pair which can be used to la
Import an existing key pair, replace `~/.ssh/id_rsa.pub` with your specified key.
```bash
aws ec2 import-key-pair --key-name "hive-key" --public-key-material fileb://~/.ssh/id_rsa.pub
aws ec2 import-key-pair --key-name "spinifex-key" --public-key-material fileb://~/.ssh/id_rsa.pub
```
If no key exists, generate one using `ssh-keygen` and repeat the command above.
@@ -163,20 +163,20 @@ Alternatively, create a new key pair using the AWS CLI tool and store the JSON o
```bash
aws ec2 create-key-pair \
--key-name hive-key \
| jq -r '.KeyMaterial | rtrimstr("\n")' > ~/.ssh/hive-key
--key-name spinifex-key \
| jq -r '.KeyMaterial | rtrimstr("\n")' > ~/.ssh/spinifex-key
```
Update permissions for the key for SSH to accept reading the file.
```bash
chmod 600 ~/.ssh/hive-key
chmod 600 ~/.ssh/spinifex-key
```
Next, generate a public key from the specified private key pair.
```bash
ssh-keygen -y -f ~/.ssh/hive-key > ~/.ssh/hive-key.pub
ssh-keygen -y -f ~/.ssh/spinifex-key > ~/.ssh/spinifex-key.pub
```
### Verify New Key
@@ -193,7 +193,7 @@ aws ec2 describe-key-pairs
"KeyType": "ed25519",
"Tags": [],
"CreateTime": "2025-10-28T13:39:23.458000+00:00",
"KeyName": "hive-key",
"KeyName": "spinifex-key",
"KeyFingerprint": "SHA256:/g/A5OkeZeSydz9WUErXYVdCt00b0VbfN6RLn2YVFAY"
}
]
@@ -202,16 +202,16 @@ aws ec2 describe-key-pairs
## Create AMI Template
The Hive CLI tool offers 2 ways of importing an image. You can use automatic image importing, and select from our range of images. Alternatively, provide your own image source file (e.g image.tar.gz, image.gz, image.tar.xz) and the tool will automatically extract and upload the raw OS image as an AMI (after validating the image contains UEFI/BIOS boot capability).
The Spinifex CLI tool offers 2 ways of importing an image. You can use automatic image importing, and select from our range of images. Alternatively, provide your own image source file (e.g image.tar.gz, image.gz, image.tar.xz) and the tool will automatically extract and upload the raw OS image as an AMI (after validating the image contains UEFI/BIOS boot capability).
**Note:** When downloading OS images, use platforms that support the `cloud-init` feature to automatically bootstrap when using the Hive EC2 functionality to access SSH and networking services.
**Note:** When downloading OS images, use platforms that support the `cloud-init` feature to automatically bootstrap when using the Spinifex EC2 functionality to access SSH and networking services.
### Automatic Image Import
Discover available images to automatically download and install. This will pull the images from the distro official mirror and simplify the process to bootstrap a Hive installation with AMIs for common operating systems.
Discover available images to automatically download and install. This will pull the images from the distro official mirror and simplify the process to bootstrap a Spinifex installation with AMIs for common operating systems.
```bash
./bin/hive admin images list
./bin/spx admin images list
```
```bash
@@ -225,7 +225,7 @@ ubuntu-24.04-x86_64 | ubuntu | 24.04 | x86_64 | bios
Next, choose the image you would like to import as an AMI. Choose the appropriate `x86_64` or `arm64` architecture depending on your platform.
```bash
./bin/hive admin images import --name debian-12-arm64
./bin/spx admin images import --name debian-12-arm64
```
### Manual Image Import
@@ -241,7 +241,7 @@ wget https://cloud.debian.org/images/cloud/bookworm/latest/debian-12-genericclou
Import as an AMI to the backend store:
```bash
./bin/hive admin images import --file ~/debian-12-genericcloud-arm64.tar.xz --arch arm64 --distro debian --version 12
./bin/spx admin images import --file ~/debian-12-genericcloud-arm64.tar.xz --arch arm64 --distro debian --version 12
```
### Verify Image Import
@@ -249,18 +249,18 @@ Import as an AMI to the backend store:
Export the AMI.
```bash
export HIVE_AMI="ami-XXX"
export SPINIFEX_AMI="ami-XXX"
```
Next, verify available disk images to confirm the import was successful.
```bash
aws ec2 describe-images --image-ids $HIVE_AMI
aws ec2 describe-images --image-ids $SPINIFEX_AMI
```
## Create VPC and Subnet
Every EC2 instance runs inside a VPC (Virtual Private Cloud) with an isolated virtual network. Hive creates a default VPC automatically during initialization, but you can also create your own.
Every EC2 instance runs inside a VPC (Virtual Private Cloud) with an isolated virtual network. Spinifex creates a default VPC automatically during initialization, but you can also create your own.
### Create a VPC
@@ -282,7 +282,7 @@ aws ec2 create-vpc --cidr-block 10.200.0.0/16
Export the VPC ID:
```bash
export HIVE_VPC="vpc-XXX"
export SPINIFEX_VPC="vpc-XXX"
```
### Create a Subnet
@@ -290,7 +290,7 @@ export HIVE_VPC="vpc-XXX"
Create a subnet within the VPC. All instances launched into this subnet will receive a private IP address from its CIDR range via DHCP.
```bash
aws ec2 create-subnet --vpc-id $HIVE_VPC --cidr-block 10.200.1.0/24
aws ec2 create-subnet --vpc-id $SPINIFEX_VPC --cidr-block 10.200.1.0/24
```
```json
@@ -308,7 +308,7 @@ aws ec2 create-subnet --vpc-id $HIVE_VPC --cidr-block 10.200.1.0/24
Export the Subnet ID — this is required when launching instances:
```bash
export HIVE_SUBNET="subnet-XXX"
export SPINIFEX_SUBNET="subnet-XXX"
```
### Verify VPC Networking
@@ -320,15 +320,15 @@ aws ec2 describe-vpcs
aws ec2 describe-subnets
```
Behind the scenes, Hive's `vpcd` service translates these into OVN topology: the VPC becomes a logical router, the subnet becomes a logical switch with DHCP options, and each instance launched into the subnet gets an OVN port with automatic IP assignment.
Behind the scenes, Spinifex's `vpcd` service translates these into OVN topology: the VPC becomes a logical router, the subnet becomes a logical switch with DHCP options, and each instance launched into the subnet gets an OVN port with automatic IP assignment.
## Run Instance
Once Hive is successfully installed and bootstrapped with a system AMI, SSH keys, and a VPC subnet, proceed to run an instance.
Once Spinifex is successfully installed and bootstrapped with a system AMI, SSH keys, and a VPC subnet, proceed to run an instance.
### Query Instance Types
Depending on the host platform Hive is installed, different compute instances will be available.
Depending on the host platform Spinifex is installed, different compute instances will be available.
Query available instance types and choose an instance type available on your host:
@@ -369,19 +369,19 @@ aws ec2 describe-instance-types
Export the instance-type:
```sh
export HIVE_INSTANCE="t3.small"
export SPINIFEX_INSTANCE="t3.small"
```
### Run Instance
Next, launch a new instance. The `--subnet-id` places the instance into your VPC subnet, where it will receive a private IP address via DHCP. The `hive-key` is the SSH key specified in the previous stage.
Next, launch a new instance. The `--subnet-id` places the instance into your VPC subnet, where it will receive a private IP address via DHCP. The `spinifex-key` is the SSH key specified in the previous stage.
```bash
aws ec2 run-instances \
--image-id $HIVE_AMI \
--instance-type $HIVE_INSTANCE \
--key-name hive-key \
--subnet-id $HIVE_SUBNET \
--image-id $SPINIFEX_AMI \
--instance-type $SPINIFEX_INSTANCE \
--key-name spinifex-key \
--subnet-id $SPINIFEX_SUBNET \
--count 1
```
@@ -402,7 +402,7 @@ A sample response is below from the `RunInstance` request. Note the `InstanceId`
"PrivateIpAddress": "10.200.1.5",
"SubnetId": "subnet-6e7f829e3a4b1c5d0",
"VpcId": "vpc-1035bd70d9bc10b06",
"KeyName": "hive-key",
"KeyName": "spinifex-key",
"InstanceType": "t3.micro",
"LaunchTime": "2025-11-12T13:07:47.548000+00:00",
"NetworkInterfaces": [
@@ -457,7 +457,7 @@ Confirm the `State.Name` attribute is set as `running` and the instance has a `P
"PrivateIpAddress": "10.200.1.5",
"SubnetId": "subnet-6e7f829e3a4b1c5d0",
"VpcId": "vpc-1035bd70d9bc10b06",
"KeyName": "hive-key",
"KeyName": "spinifex-key",
"InstanceType": "t3.micro",
"LaunchTime": "2025-11-12T13:07:47.548000+00:00"
}
@@ -469,7 +469,7 @@ Confirm the `State.Name` attribute is set as `running` and the instance has a `P
## SSH Connection (development)
For a Hive development environment (toggled off for production), a local SSH port forwarding will be active to connect directly to the instance, regardless of the VPC and network settings.
For a Spinifex development environment (toggled off for production), a local SSH port forwarding will be active to connect directly to the instance, regardless of the VPC and network settings.
Determine the SSH port allocated.
@@ -484,12 +484,12 @@ qemu-system-x86_64 -daemonize -pidfile /run/user/1000/i-36765eb0c6609e4d.pid -qm
Note the `hostfwd=tcp:127.0.0.1:33683-:22`, in this case the local port `33683` will connect to the new instance.
```bash
ssh -i ~/.ssh/hive-key ec2-user@127.0.0.1 -p 33683
ssh -i ~/.ssh/spinifex-key ec2-user@127.0.0.1 -p 33683
...
Linux hive-vm-36765eb0 6.1.0-40-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.153-1 (2025-09-20) x86_64
ec2-user@hive-vm-36765eb0:~$
Linux spinifex-vm-36765eb0 6.1.0-40-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.153-1 (2025-09-20) x86_64
ec2-user@spinifex-vm-36765eb0:~$
```
Congratulations! Your first AMI image is imported, a new EC2 instance launched, and successfully connected via SSH for the configured SSH key, using the OS `cloud-init` procedure.
@@ -542,7 +542,7 @@ aws ec2 describe-instances --instance-ids $INSTANCE_ID
"Code": 80,
"Name": "stopped"
},
"KeyName": "hive-key",
"KeyName": "spinifex-key",
"InstanceType": "t3.micro",
"LaunchTime": "2025-11-12T13:07:47.548000+00:00"
}
@@ -598,7 +598,7 @@ aws ec2 describe-instances --instance-ids "i-36765eb0c6609e4d2"
"Code": 16,
"Name": "running"
},
"KeyName": "hive-key",
"KeyName": "spinifex-key",
"InstanceType": "t3.micro",
"LaunchTime": "2025-11-12T13:07:47.548000+00:00"
}
@@ -644,29 +644,29 @@ On success no data will be returned, since the instance is no longer available.
## Additional Accounts (Optional)
The default `hive` account is created automatically during init. To create additional isolated accounts with their own resources (instances, volumes, VPCs, key pairs):
The default `spx` account is created automatically during init. To create additional isolated accounts with their own resources (instances, volumes, VPCs, key pairs):
```bash
./bin/hive admin account create --name myteam
./bin/spx admin account create --name myteam
```
This provisions an IAM account with an admin user, generates access keys, and configures a local AWS CLI profile named `hive-myteam`. Resources created under one account are isolated from other accounts.
This provisions an IAM account with an admin user, generates access keys, and configures a local AWS CLI profile named `spinifex-myteam`. Resources created under one account are isolated from other accounts.
```bash
export AWS_PROFILE=hive-myteam
export AWS_PROFILE=spinifex-myteam
```
## UI Management Panel
The Hive Platform also offers a web interface for managing hive services. Simply have the hive server running and go to [https://localhost:3000](https://localhost:3000) in your browser to continue.
The Spinifex Platform also offers a web interface for managing spx services. Simply have the hive server running and go to [https://localhost:3000](https://localhost:3000) in your browser to continue.
**Note:** If you are not viewing the website on the same machine that is running the hive server, you will need to go to [https://localhost:9999](https://localhost:9999) and [https://localhost:8443](https://localhost:8443) and accept the certificates. If you have added the CA to your local machine this is not needed.
**Note:** If you are not viewing the website on the same machine that is running the spinifex server, you will need to go to [https://localhost:9999](https://localhost:9999) and [https://localhost:8443](https://localhost:8443) and accept the certificates. If you have added the CA to your local machine this is not needed.
# Multi-Node Installation
Hive is designed for distributed, multi-server deployments. A Hive cluster operates as a fully distributed infrastructure region — similar to an AWS Region — where multiple nodes work together to provide high availability, data durability, and fault tolerance across the platform.
Spinifex is designed for distributed, multi-server deployments. A Spinifex cluster operates as a fully distributed infrastructure region — similar to an AWS Region — where multiple nodes work together to provide high availability, data durability, and fault tolerance across the platform.
When deploying a multi-node cluster, you define a **region** (e.g., `ap-southeast-2`, `us-east-1`) and **availability zones** to organize your infrastructure. Services are distributed across nodes: NATS provides a clustered message bus for request routing and JetStream replication, Predastore uses Raft consensus with Reed-Solomon erasure coding (RS 2+1) for durable S3-compatible object storage, and the Hive daemon on each node can independently serve AWS API requests. The result is a platform where compute, storage, and API services are replicated — an AMI stored on one node is available from any node, an EC2 instance launched via any gateway is visible cluster-wide, and the loss of a single node does not compromise data or availability.
When deploying a multi-node cluster, you define a **region** (e.g., `ap-southeast-2`, `us-east-1`) and **availability zones** to organize your infrastructure. Services are distributed across nodes: NATS provides a clustered message bus for request routing and JetStream replication, Predastore uses Raft consensus with Reed-Solomon erasure coding (RS 2+1) for durable S3-compatible object storage, and the Spinifex daemon on each node can independently serve AWS API requests. The result is a platform where compute, storage, and API services are replicated — an AMI stored on one node is available from any node, an EC2 instance launched via any gateway is visible cluster-wide, and the loss of a single node does not compromise data or availability.
Cluster formation is automatic. When initializing with `--nodes 3`, the init node starts a formation server and waits for other nodes to join. Once all nodes have registered, each node receives the full cluster topology — credentials, CA certificates, NATS routes, Predastore peer lists — and generates its own configuration files. No manual configuration synchronization is required.
@@ -677,9 +677,9 @@ Cluster formation is automatic. When initializing with `--nodes 3`, the init nod
| **Servers** | 1 machine, loopback IPs | 3+ physical/virtual servers |
| **Use case** | Development & testing | Production & staging |
| **Network** | `127.0.0.1/2/3` (no setup) | Real LAN IPs |
| **Data dirs** | `~/node1/`, `~/node2/`, `~/node3/` | `~/hive/` on each server |
| **Data dirs** | `~/node1/`, `~/node2/`, `~/node3/` | `~/spinifex/` on each server |
Both options use `HIVE_NODE1`, `HIVE_NODE2`, and `HIVE_NODE3` environment variables. Set them in the option you choose, then all subsequent sections (verification, usage, shutdown) reference them.
Both options use `SPINIFEX_NODE1`, `SPINIFEX_NODE2`, and `SPINIFEX_NODE3` environment variables. Set them in the option you choose, then all subsequent sections (verification, usage, shutdown) reference them.
### Option A: Simulated Multi-Node (Single Server)
@@ -690,9 +690,9 @@ For development and testing, a 3-node cluster can be simulated on a single machi
```bash
make build
export HIVE_NODE1=127.0.0.1
export HIVE_NODE2=127.0.0.2
export HIVE_NODE3=127.0.0.3
export SPINIFEX_NODE1=127.0.0.1
export SPINIFEX_NODE2=127.0.0.2
export SPINIFEX_NODE3=127.0.0.3
```
#### 2. Setup OVN
@@ -712,28 +712,28 @@ The formation process requires running init and join commands concurrently. The
**Terminal 1 — Initialize the leader node:**
```bash
./bin/hive admin init \
./bin/spx admin init \
--node node1 \
--nodes 3 \
--bind $HIVE_NODE1 \
--cluster-bind $HIVE_NODE1 \
--bind $SPINIFEX_NODE1 \
--cluster-bind $SPINIFEX_NODE1 \
--port 4432 \
--hive-dir ~/node1/ \
--spinifex-dir ~/node1/ \
--config-dir ~/node1/config/ \
--region ap-southeast-2 \
--az ap-southeast-2a
```
This starts a formation server on `$HIVE_NODE1:4432` and waits for 2 more nodes to join.
This starts a formation server on `$SPINIFEX_NODE1:4432` and waits for 2 more nodes to join.
**Terminal 2 — Join node 2 (while init is running):**
```bash
./bin/hive admin join \
./bin/spx admin join \
--node node2 \
--bind $HIVE_NODE2 \
--cluster-bind $HIVE_NODE2 \
--host $HIVE_NODE1:4432 \
--bind $SPINIFEX_NODE2 \
--cluster-bind $SPINIFEX_NODE2 \
--host $SPINIFEX_NODE1:4432 \
--data-dir ~/node2/ \
--config-dir ~/node2/config/ \
--region ap-southeast-2 \
@@ -743,11 +743,11 @@ This starts a formation server on `$HIVE_NODE1:4432` and waits for 2 more nodes
**Terminal 3 — Join node 3 (while init is running):**
```bash
./bin/hive admin join \
./bin/spx admin join \
--node node3 \
--bind $HIVE_NODE3 \
--cluster-bind $HIVE_NODE3 \
--host $HIVE_NODE1:4432 \
--bind $SPINIFEX_NODE3 \
--cluster-bind $SPINIFEX_NODE3 \
--host $SPINIFEX_NODE1:4432 \
--data-dir ~/node3/ \
--config-dir ~/node3/config/ \
--region ap-southeast-2 \
@@ -774,14 +774,14 @@ For production or production-like deployments across multiple physical servers o
On **each server**:
1. Install Hive dependencies (see [Dependencies](#dependencies) above)
1. Install Spinifex dependencies (see [Dependencies](#dependencies) above)
2. Clone the repository and build:
```bash
mkdir -p ~/Development/mulga/
cd ~/Development/mulga/
git clone https://github.com/mulgadc/hive.git
cd hive
git clone https://github.com/mulgadc/spinifex.git
cd spinifex
./scripts/clone-deps.sh
make build
```
@@ -802,9 +802,9 @@ With a **single NIC**, use the one real IP (e.g. `192.168.1.10`) for everything.
Export the IPs for your three servers (replace with your actual IPs) on each server:
```bash
export HIVE_NODE1=192.168.1.10
export HIVE_NODE2=192.168.1.11
export HIVE_NODE3=192.168.1.12
export SPINIFEX_NODE1=192.168.1.10
export SPINIFEX_NODE2=192.168.1.11
export SPINIFEX_NODE3=192.168.1.12
```
#### 2. Setup OVN
@@ -816,8 +816,8 @@ OVN must be configured on every server before forming the cluster. Server 1 runs
**Server 1 — OVN central + compute (run first):**
```bash
cd ~/Development/mulga/hive
./scripts/setup-ovn.sh --management --encap-ip=$HIVE_NODE1
cd ~/Development/mulga/spinifex
./scripts/setup-ovn.sh --management --encap-ip=$SPINIFEX_NODE1
```
Verify OVN central is ready before proceeding to other servers:
@@ -829,15 +829,15 @@ sudo ovn-sbctl show
**Server 2 — Compute node (after server 1 is ready):**
```bash
cd ~/Development/mulga/hive
./scripts/setup-ovn.sh --ovn-remote=tcp:$HIVE_NODE1:6642 --encap-ip=$HIVE_NODE2
cd ~/Development/mulga/spinifex
./scripts/setup-ovn.sh --ovn-remote=tcp:$SPINIFEX_NODE1:6642 --encap-ip=$SPINIFEX_NODE2
```
**Server 3 — Compute node (after server 1 is ready):**
```bash
cd ~/Development/mulga/hive
./scripts/setup-ovn.sh --ovn-remote=tcp:$HIVE_NODE1:6642 --encap-ip=$HIVE_NODE3
cd ~/Development/mulga/spinifex
./scripts/setup-ovn.sh --ovn-remote=tcp:$SPINIFEX_NODE1:6642 --encap-ip=$SPINIFEX_NODE3
```
Verify OVN is running on all servers:
@@ -861,16 +861,16 @@ If your servers have a dedicated data/overlay NIC separate from the management N
**Server 1 — Initialize the cluster:**
```bash
cd ~/Development/mulga/hive
cd ~/Development/mulga/spinifex
./bin/hive admin init \
./bin/spx admin init \
--node node1 \
--nodes 3 \
--bind $HIVE_NODE1 \
--cluster-bind $HIVE_NODE1 \
--bind $SPINIFEX_NODE1 \
--cluster-bind $SPINIFEX_NODE1 \
--port 4432 \
--hive-dir ~/hive/ \
--config-dir ~/hive/config/ \
--spinifex-dir ~/spinifex/ \
--config-dir ~/spinifex/config/ \
--region us-east-1 \
--az us-east-1a
```
@@ -878,15 +878,15 @@ cd ~/Development/mulga/hive
**Server 2 — Join the cluster (while init is running):**
```bash
cd ~/Development/mulga/hive
cd ~/Development/mulga/spinifex
./bin/hive admin join \
./bin/spx admin join \
--node node2 \
--bind $HIVE_NODE2 \
--cluster-bind $HIVE_NODE2 \
--host $HIVE_NODE1:4432 \
--data-dir ~/hive/ \
--config-dir ~/hive/config/ \
--bind $SPINIFEX_NODE2 \
--cluster-bind $SPINIFEX_NODE2 \
--host $SPINIFEX_NODE1:4432 \
--data-dir ~/spinifex/ \
--config-dir ~/spinifex/config/ \
--region us-east-1 \
--az us-east-1a
```
@@ -894,15 +894,15 @@ cd ~/Development/mulga/hive
**Server 3 — Join the cluster (while init is running):**
```bash
cd ~/Development/mulga/hive
cd ~/Development/mulga/spinifex
./bin/hive admin join \
./bin/spx admin join \
--node node3 \
--bind $HIVE_NODE3 \
--cluster-bind $HIVE_NODE3 \
--host $HIVE_NODE1:4432 \
--data-dir ~/hive/ \
--config-dir ~/hive/config/ \
--bind $SPINIFEX_NODE3 \
--cluster-bind $SPINIFEX_NODE3 \
--host $SPINIFEX_NODE1:4432 \
--data-dir ~/spinifex/ \
--config-dir ~/spinifex/config/ \
--region us-east-1 \
--az us-east-1a
```
@@ -922,41 +922,41 @@ After formation completes, start services on **all servers**:
From any node, view cluster status and resource capacity:
```bash
./bin/hive get nodes
./bin/spx get nodes
# NAME STATUS IP REGION AZ UPTIME VMs SERVICES
# node1 Ready $HIVE_NODE1 ... ... 2m 0 nats,predastore,viperblock,daemon,...
# node2 Ready $HIVE_NODE2 ... ... 2m 0 nats,predastore,viperblock,daemon
# node3 Ready $HIVE_NODE3 ... ... 2m 0 nats,predastore,viperblock,daemon
# node1 Ready $SPINIFEX_NODE1 ... ... 2m 0 nats,predastore,viperblock,daemon,...
# node2 Ready $SPINIFEX_NODE2 ... ... 2m 0 nats,predastore,viperblock,daemon
# node3 Ready $SPINIFEX_NODE3 ... ... 2m 0 nats,predastore,viperblock,daemon
./bin/hive top nodes
./bin/spx top nodes
# NAME CPU (used/total) MEM (used/total) VMs
# node1 0/16 0.0Gi/30.6Gi 0
# node2 0/16 0.0Gi/30.6Gi 0
# node3 0/16 0.0Gi/30.6Gi 0
```
All nodes should show `Ready` status. Use `./bin/hive get vms` to see running instances across the cluster.
All nodes should show `Ready` status. Use `./bin/spx get vms` to see running instances across the cluster.
Check individual daemon health endpoints:
```bash
curl -s http://$HIVE_NODE1:4432/health
curl -s http://$HIVE_NODE2:4432/health
curl -s http://$HIVE_NODE3:4432/health
curl -s http://$SPINIFEX_NODE1:4432/health
curl -s http://$SPINIFEX_NODE2:4432/health
curl -s http://$SPINIFEX_NODE3:4432/health
```
Check NATS cluster routing (from any node):
```bash
grep -i "route\|cluster" ~/node1/logs/nats.log # simulated
grep -i "route\|cluster" ~/hive/logs/nats.log # real multi-server
grep -i "route\|cluster" ~/spinifex/logs/nats.log # real multi-server
```
Check Predastore Raft consensus:
```bash
grep -i "leader\|election" ~/node1/logs/predastore.log # simulated
grep -i "leader\|election" ~/hive/logs/predastore.log # real multi-server
grep -i "leader\|election" ~/spinifex/logs/predastore.log # real multi-server
```
## Trust CA Certificate
@@ -964,21 +964,21 @@ grep -i "leader\|election" ~/hive/logs/predastore.log # real multi-server
The CA certificate is generated by the init node and distributed to all joining nodes during formation. On **each node** (or the single machine for simulated mode), trust the CA:
```bash
sudo cp ~/hive/config/ca.pem /usr/local/share/ca-certificates/hive-ca.crt
sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates
```
For simulated mode, the config directory is under each node's data directory — copy from any node since the CA is the same:
```bash
sudo cp ~/node1/config/ca.pem /usr/local/share/ca-certificates/hive-ca.crt
sudo cp ~/node1/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates
```
Set the AWS profile to use the default admin account created during init:
```bash
export AWS_PROFILE=hive
export AWS_PROFILE=spinifex
```
## Using the Cluster
@@ -986,8 +986,8 @@ export AWS_PROFILE=hive
Connect to any node's AWS Gateway — all nodes serve the same cluster state:
```bash
AWS_ENDPOINT_URL=https://$HIVE_NODE1:9999 aws ec2 describe-instances
AWS_ENDPOINT_URL=https://$HIVE_NODE2:9999 aws ec2 describe-instances
AWS_ENDPOINT_URL=https://$SPINIFEX_NODE1:9999 aws ec2 describe-instances
AWS_ENDPOINT_URL=https://$SPINIFEX_NODE2:9999 aws ec2 describe-instances
```
### Create SSH Key
@@ -995,24 +995,24 @@ AWS_ENDPOINT_URL=https://$HIVE_NODE2:9999 aws ec2 describe-instances
Create or import an SSH key pair from **any node** — the key is stored in Predastore and available cluster-wide:
```bash
aws ec2 import-key-pair --key-name "hive-key" --public-key-material fileb://~/.ssh/id_rsa.pub
aws ec2 import-key-pair --key-name "spinifex-key" --public-key-material fileb://~/.ssh/id_rsa.pub
```
Or generate a new key pair:
```bash
aws ec2 create-key-pair \
--key-name hive-key \
| jq -r '.KeyMaterial | rtrimstr("\n")' > ~/.ssh/hive-key
chmod 600 ~/.ssh/hive-key
--key-name spinifex-key \
| jq -r '.KeyMaterial | rtrimstr("\n")' > ~/.ssh/spinifex-key
chmod 600 ~/.ssh/spinifex-key
```
**Important:** If you want to ssh into instances, you will need to copy the private key to every node in the cluster. Instance SSH port forwarding is only accessible from the node running the VM, so you need the key available on all nodes:
```bash
# From the node where the key was created, copy to other nodes:
scp ~/.ssh/hive-key tf-user@$HIVE_NODE2:~/.ssh/hive-key
scp ~/.ssh/hive-key tf-user@$HIVE_NODE3:~/.ssh/hive-key
scp ~/.ssh/spinifex-key tf-user@$SPINIFEX_NODE2:~/.ssh/spinifex-key
scp ~/.ssh/spinifex-key tf-user@$SPINIFEX_NODE3:~/.ssh/spinifex-key
```
### Create AMI Template
@@ -1020,15 +1020,15 @@ scp ~/.ssh/hive-key tf-user@$HIVE_NODE3:~/.ssh/hive-key
Import an OS image from **any node**. The AMI is stored in Predastore and available cluster-wide:
```bash
./bin/hive admin images list
./bin/hive admin images import --name debian-12-x86_64
./bin/spx admin images list
./bin/spx admin images import --name debian-12-x86_64
```
Verify and export the AMI ID:
```bash
aws ec2 describe-images
export HIVE_AMI="ami-XXX"
export SPINIFEX_AMI="ami-XXX"
```
See the [single-node AMI section](#create-ami-template) for more options (manual import, custom images).
@@ -1039,10 +1039,10 @@ Create a VPC and subnet for your cluster. This only needs to be done once — th
```bash
aws ec2 create-vpc --cidr-block 10.200.0.0/16
export HIVE_VPC="vpc-XXX"
export SPINIFEX_VPC="vpc-XXX"
aws ec2 create-subnet --vpc-id $HIVE_VPC --cidr-block 10.200.1.0/24
export HIVE_SUBNET="subnet-XXX"
aws ec2 create-subnet --vpc-id $SPINIFEX_VPC --cidr-block 10.200.1.0/24
export SPINIFEX_SUBNET="subnet-XXX"
```
Verify the OVN topology was created (from server 1):
@@ -1054,14 +1054,14 @@ sudo ovn-nbctl ls-list # One logical switch per subnet
### Launching Instances Across Nodes
Use `--count` to launch multiple instances in a single request. Hive distributes them across nodes in the cluster based on available capacity — instances land on different physical hosts but share the same VPC subnet, and can route traffic to each other over OVN's Geneve overlay:
Use `--count` to launch multiple instances in a single request. Spinifex distributes them across nodes in the cluster based on available capacity — instances land on different physical hosts but share the same VPC subnet, and can route traffic to each other over OVN's Geneve overlay:
```bash
aws ec2 run-instances \
--image-id $HIVE_AMI \
--instance-type $HIVE_INSTANCE \
--key-name hive-key \
--subnet-id $HIVE_SUBNET \
--image-id $SPINIFEX_AMI \
--instance-type $SPINIFEX_INSTANCE \
--key-name spinifex-key \
--subnet-id $SPINIFEX_SUBNET \
--count 3
```
@@ -1076,7 +1076,7 @@ aws ec2 describe-instances
Check which node each instance landed on:
```bash
./bin/hive get vms
./bin/spx get vms
```
### Verifying Cross-Host Connectivity
@@ -1090,7 +1090,7 @@ ps auxw | grep hostfwd
```
```bash
ssh -i ~/.ssh/hive-key ec2-user@<node-ip> -p <port>
ssh -i ~/.ssh/spinifex-key ec2-user@<node-ip> -p <port>
```
From inside the VM, ping an instance running on a **different physical node**:
@@ -1101,7 +1101,7 @@ ping 10.200.1.6
If the ping succeeds across hosts, the OVN Geneve overlay is working correctly — traffic is being encapsulated and routed between physical servers transparently.
Check logs on each node for debugging. Log locations depend on your deployment mode — `~/node{1,2,3}/logs/` for simulated, `~/hive/logs/` for real multi-server.
Check logs on each node for debugging. Log locations depend on your deployment mode — `~/node{1,2,3}/logs/` for simulated, `~/spinifex/logs/` for real multi-server.
## Advanced Configuration
@@ -1154,14 +1154,14 @@ Example with management NIC `192.168.1.0/24` and overlay NIC `10.0.0.0/24`. The
Server 1:
```bash
./bin/hive admin init \
./bin/spx admin init \
--node node1 \
--nodes 3 \
--bind 192.168.1.10 \
--cluster-bind 192.168.1.10 \
--port 4432 \
--hive-dir ~/hive/ \
--config-dir ~/hive/config/ \
--spinifex-dir ~/spinifex/ \
--config-dir ~/spinifex/config/ \
--region us-east-1 \
--az us-east-1a
```
@@ -1169,13 +1169,13 @@ Server 1:
Server 2 (while init is running):
```bash
./bin/hive admin join \
./bin/spx admin join \
--node node2 \
--bind 192.168.1.11 \
--cluster-bind 192.168.1.11 \
--host 192.168.1.10:4432 \
--data-dir ~/hive/ \
--config-dir ~/hive/config/ \
--data-dir ~/spinifex/ \
--config-dir ~/spinifex/config/ \
--region us-east-1 \
--az us-east-1a
```
@@ -1183,13 +1183,13 @@ Server 2 (while init is running):
Server 3 (while init is running):
```bash
./bin/hive admin join \
./bin/spx admin join \
--node node3 \
--bind 192.168.1.12 \
--cluster-bind 192.168.1.12 \
--host 192.168.1.10:4432 \
--data-dir ~/hive/ \
--config-dir ~/hive/config/ \
--data-dir ~/spinifex/ \
--config-dir ~/spinifex/config/ \
--region us-east-1 \
--az us-east-1a
```
@@ -1204,7 +1204,7 @@ sudo ip addr add 10.11.12.2/24 dev eth0
sudo ip addr add 10.11.12.3/24 dev eth0
```
Replace `eth0` with your network interface name (e.g., `enp0s3`, `ens33`). Then export these as your `HIVE_NODE` variables instead of the loopback addresses.
Replace `eth0` with your network interface name (e.g., `enp0s3`, `ens33`). Then export these as your `SPINIFEX_NODE` variables instead of the loopback addresses.
To remove the aliases:
@@ -1221,7 +1221,7 @@ When running in the multi-server cluster mode a graceful shutdown is required to
On any node, issue the following command to shutdown nodes cluster wide:
```sh
./bin/hive admin cluster shutdown
./bin/spx admin cluster shutdown
```
Example output:
@@ -1231,9 +1231,9 @@ Phases: gate -> drain -> storage -> persist -> infra
Timeout per phase: 2m0s
[GATE] Sending to 3 node(s)...
[GATE] node1: stopped awsgw, hive-ui
[GATE] node3: stopped awsgw, hive-ui
[GATE] node2: stopped awsgw, hive-ui
[GATE] node1: stopped awsgw, spinifex-ui
[GATE] node3: stopped awsgw, spinifex-ui
[GATE] node2: stopped awsgw, spinifex-ui
[GATE] Complete (3/3 nodes, 2.005s)
[DRAIN] Sending to 3 node(s)...
docs/README.md
+2 -2
View File
@@ -1,3 +1,3 @@
# Hive Documentation
# Spinifex Documentation
This directory contains the Hive documentation. This is available in individual markdown files, and a generated website to aid navigation and browing documentation at: [https://docs.mulgadc.com](https://docs.mulgadc.com/)
This directory contains the Spinifex documentation. This is available in individual markdown files, and a generated website to aid navigation and browing documentation at: [https://docs.mulgadc.com](https://docs.mulgadc.com/)
docs/creating-accounts/README.md
+6 -6
View File
@@ -7,8 +7,8 @@ tags:
- iam
- admin
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
---
# Creating Accounts
@@ -25,15 +25,15 @@ resources:
## Overview
Hive supports multi-tenant account isolation. Each account gets its own IAM credentials, AWS CLI profile, and isolated resource namespace.
Spinifex supports multi-tenant account isolation. Each account gets its own IAM credentials, AWS CLI profile, and isolated resource namespace.
## Instructions
## Create Account
```bash
./bin/hive admin account create --name myteam
export AWS_PROFILE=hive-myteam
./bin/spx admin account create --name myteam
export AWS_PROFILE=spinifex-myteam
```
## Verify
@@ -57,5 +57,5 @@ Ensure the `AWS_PROFILE` environment variable matches the profile name:
```bash
echo $AWS_PROFILE
export AWS_PROFILE=hive-myteam
export AWS_PROFILE=spinifex-myteam
```
docs/creating-an-environment/README.md
+19 -19
View File
@@ -8,8 +8,8 @@ tags:
- ec2
- ssh
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
- title: "Debian Cloud Images"
url: "https://cloud.debian.org/images/cloud/bookworm/latest/"
---
@@ -28,7 +28,7 @@ resources:
## Overview
This guide walks through the complete workflow for creating a production-ready Hive environment.
This guide walks through the complete workflow for creating a production-ready Spinifex environment.
**Steps:**
1. Create a user account
@@ -44,35 +44,35 @@ This guide walks through the complete workflow for creating a production-ready H
## 1. Import SSH Key
```bash
aws ec2 import-key-pair --key-name "hive-key" --public-key-material fileb://~/.ssh/id_rsa.pub
aws ec2 import-key-pair --key-name "spinifex-key" --public-key-material fileb://~/.ssh/id_rsa.pub
```
## 2. Create VPC
```bash
aws ec2 create-vpc --cidr-block 10.200.0.0/16
export HIVE_VPC="vpc-XXX"
export SPINIFEX_VPC="vpc-XXX"
aws ec2 create-subnet --vpc-id $HIVE_VPC --cidr-block 10.200.1.0/24
export HIVE_SUBNET="subnet-XXX"
aws ec2 create-subnet --vpc-id $SPINIFEX_VPC --cidr-block 10.200.1.0/24
export SPINIFEX_SUBNET="subnet-XXX"
```
## 3. Import AMI
```bash
./bin/hive admin images list
./bin/hive admin images import --name debian-12-x86_64
export HIVE_AMI="ami-XXX"
./bin/spx admin images list
./bin/spx admin images import --name debian-12-x86_64
export SPINIFEX_AMI="ami-XXX"
```
## 4. Launch Instance
```bash
aws ec2 run-instances \
--image-id $HIVE_AMI \
--image-id $SPINIFEX_AMI \
--instance-type t3.small \
--key-name hive-key \
--subnet-id $HIVE_SUBNET \
--key-name spinifex-key \
--subnet-id $SPINIFEX_SUBNET \
--count 1
```
@@ -82,24 +82,24 @@ aws ec2 run-instances \
ps auxw | grep $INSTANCE_ID
# Look for: hostfwd=tcp:127.0.0.1:<port>-:22
ssh -i ~/.ssh/hive-key ec2-user@127.0.0.1 -p <port>
ssh -i ~/.ssh/spinifex-key ec2-user@127.0.0.1 -p <port>
```
## Troubleshooting
## Instance stuck in pending
Check the Hive daemon and QEMU logs for boot errors:
Check the Spinifex daemon and QEMU logs for boot errors:
```bash
ls ~/hive/logs/
cat ~/hive/logs/daemon.log
ls ~/spinifex/logs/
cat ~/spinifex/logs/daemon.log
```
Verify the AMI exists and architecture matches your host:
```bash
aws ec2 describe-images --image-ids $HIVE_AMI
aws ec2 describe-images --image-ids $SPINIFEX_AMI
```
## SSH connection refused
@@ -115,5 +115,5 @@ ps auxw | grep hostfwd
Ensure you're using the correct key and port:
```bash
ssh -i ~/.ssh/hive-key ec2-user@127.0.0.1 -p <port>
ssh -i ~/.ssh/spinifex-key ec2-user@127.0.0.1 -p <port>
```
docs/hybrid-sync/README.md
+10 -10
View File
@@ -1,19 +1,19 @@
---
title: "Hybrid Sync"
description: "Synchronize data between Hive and AWS when network connectivity is available."
description: "Synchronize data between Spinifex and AWS when network connectivity is available."
category: "Migration"
tags:
- hybrid
- sync
- s3
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
---
# Hybrid Sync
> Synchronize data between Hive and AWS when network connectivity is available.
> Synchronize data between Spinifex and AWS when network connectivity is available.
## Table of Contents
@@ -25,7 +25,7 @@ resources:
## Overview
Hive's hybrid mode enables bidirectional data synchronization between local infrastructure and AWS cloud services. Ideal for intermittent connectivity environments.
Spinifex's hybrid mode enables bidirectional data synchronization between local infrastructure and AWS cloud services. Ideal for intermittent connectivity environments.
## Instructions
@@ -33,20 +33,20 @@ Hive's hybrid mode enables bidirectional data synchronization between local infr
```bash
aws s3 sync s3://local-bucket/ s3://cloud-bucket/ \
--source-region hive --region us-east-1
--source-region spinifex --region us-east-1
```
## Pull Cloud to Local
```bash
aws s3 sync s3://cloud-bucket/ s3://local-bucket/ \
--source-region us-east-1 --region hive
--source-region us-east-1 --region spinifex
```
## EBS Volume Backup
```bash
rsync -avz /data/ user@cloud-server:/backup/hive-data/
rsync -avz /data/ user@cloud-server:/backup/spinifex-data/
```
## Troubleshooting
@@ -57,7 +57,7 @@ S3 sync is idempotent — re-run the same command to resume where it left off:
```bash
aws s3 sync s3://local-bucket/ s3://cloud-bucket/ \
--source-region hive --region us-east-1
--source-region spinifex --region us-east-1
```
Only changed or missing files will be transferred on subsequent runs.
@@ -67,7 +67,7 @@ Only changed or missing files will be transferred on subsequent runs.
Verify your AWS credentials are configured for both the source and destination:
```bash
aws sts get-caller-identity --profile hive
aws sts get-caller-identity --profile spinifex
aws sts get-caller-identity --profile default
```
docs/installing-hive-airgapped/README.md → docs/installing-spinifex-airgapped/README.md
+9 -9
View File
@@ -1,6 +1,6 @@
---
title: "Air-Gapped Installation"
description: "Deploy Hive in environments without internet connectivity. Covers offline package caching, USB deployment, and package verification."
description: "Deploy Spinifex in environments without internet connectivity. Covers offline package caching, USB deployment, and package verification."
category: "Getting Started"
tags:
- install
@@ -8,15 +8,15 @@ tags:
- offline
badge: advanced
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
- title: "apt-cacher-ng"
url: "https://wiki.debian.org/AptCacherNg"
---
# Air-Gapped Installation
> Deploy Hive in environments without internet connectivity.
> Deploy Spinifex in environments without internet connectivity.
## Table of Contents
@@ -28,7 +28,7 @@ resources:
## Overview
In air-gapped or disconnected environments, Hive can be deployed without internet access. This guide covers preparing offline packages on a connected machine, creating USB deployment media, and installing on the target server with package verification.
In air-gapped or disconnected environments, Spinifex can be deployed without internet access. This guide covers preparing offline packages on a connected machine, creating USB deployment media, and installing on the target server with package verification.
**Deployment methods:**
- **apt-cacher-ng** — Local APT cache for Debian/Ubuntu packages
@@ -47,7 +47,7 @@ sudo apt install apt-cacher-ng
sudo systemctl enable --now apt-cacher-ng
```
Pre-download all Hive dependencies:
Pre-download all Spinifex dependencies:
```bash
sudo apt install --download-only nbdkit nbdkit-plugin-dev pkg-config \
@@ -62,7 +62,7 @@ sudo apt install --download-only nbdkit nbdkit-plugin-dev pkg-config \
mkdir -p /media/hive-deploy/{apt-packages,go-cache,hive-source}
cp /var/cache/apt/archives/*.deb /media/hive-deploy/apt-packages/
cp -r ~/go/pkg/mod/cache/ /media/hive-deploy/go-cache/
cp -r ~/Development/mulga/hive /media/hive-deploy/hive-source/
cp -r ~/Development/mulga/spinifex /media/hive-deploy/hive-source/
```
## Step 3. Verify package integrity
@@ -82,8 +82,8 @@ Mount the USB and install:
```bash
sudo mount /dev/sdb1 /mnt/usb
sudo dpkg -i /mnt/usb/apt-packages/*.deb
cp -r /mnt/usb/hive-source ~/Development/mulga/hive
cd ~/Development/mulga/hive && make build
cp -r /mnt/usb/hive-source ~/Development/mulga/spinifex
cd ~/Development/mulga/spinifex && make build
```
Then follow the [Source Install](/docs/source-install) guide from Step 3 (Setup OVN) onwards.
docs/installing-hive-multi-node/README.md → docs/installing-spinifex-multi-node/README.md
+38 -38
View File
@@ -1,6 +1,6 @@
---
title: "Multi-Node Installation"
description: "Deploy Hive across multiple servers to create an availability zone with high availability, data durability, and fault tolerance."
description: "Deploy Spinifex across multiple servers to create an availability zone with high availability, data durability, and fault tolerance."
category: "Getting Started"
tags:
- install
@@ -8,8 +8,8 @@ tags:
- cluster
badge: availability-zone
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
- title: "Predastore (S3)"
url: "https://github.com/mulgadc/predastore"
- title: "Viperblock (EBS)"
@@ -18,7 +18,7 @@ resources:
# Multi-Node Installation
> Deploy Hive across multiple servers to create an availability zone.
> Deploy Spinifex across multiple servers to create an availability zone.
## Table of Contents
@@ -30,13 +30,13 @@ resources:
## Overview
A Hive cluster operates as a fully distributed infrastructure region — similar to an AWS Region — where multiple nodes provide high availability, data durability, and fault tolerance.
A Spinifex cluster operates as a fully distributed infrastructure region — similar to an AWS Region — where multiple nodes provide high availability, data durability, and fault tolerance.
**Services distributed across nodes:**
- **NATS** — Clustered message bus for request routing and JetStream replication
- **Predastore** — Raft consensus with Reed-Solomon erasure coding (RS 2+1)
- **Viperblock** — Block storage co-located with compute nodes
- **Hive Daemon** — Independent AWS API request serving per node
- **Spinifex Daemon** — Independent AWS API request serving per node
Cluster formation is automatic. When initializing with `--nodes 3`, the init node starts a formation server and waits for peers to join. Once all nodes register, each receives the full cluster topology — credentials, CA certificates, NATS routes, Predastore peer lists — no manual configuration synchronization required.
@@ -47,7 +47,7 @@ Cluster formation is automatic. When initializing with `--nodes 3`, the init nod
## Instructions
## Step 1. Install Hive on each server
## Step 1. Install Spinifex on each server
Run the binary installer on **every server** in the cluster:
@@ -60,9 +60,9 @@ curl https://install.mulgadc.com/ | bash
On **each server**, export the IPs for all nodes (replace with your actual IPs):
```bash
export HIVE_NODE1=192.168.1.10
export HIVE_NODE2=192.168.1.11
export HIVE_NODE3=192.168.1.12
export SPINIFEX_NODE1=192.168.1.10
export SPINIFEX_NODE2=192.168.1.11
export SPINIFEX_NODE3=192.168.1.12
```
To find your server's IP:
@@ -85,7 +85,7 @@ OVN must be configured on every server before forming the cluster. Server 1 runs
**Server 1 — OVN central + compute (run first):**
```bash
sudo /usr/local/share/hive/setup-ovn.sh --management --encap-ip=$HIVE_NODE1
sudo /usr/local/share/hive/setup-ovn.sh --management --encap-ip=$SPINIFEX_NODE1
```
Verify OVN central is ready before proceeding:
@@ -97,13 +97,13 @@ sudo ovn-sbctl show
**Server 2 — Compute node (after server 1 is ready):**
```bash
sudo /usr/local/share/hive/setup-ovn.sh --ovn-remote=tcp:$HIVE_NODE1:6642 --encap-ip=$HIVE_NODE2
sudo /usr/local/share/hive/setup-ovn.sh --ovn-remote=tcp:$SPINIFEX_NODE1:6642 --encap-ip=$SPINIFEX_NODE2
```
**Server 3 — Compute node (after server 1 is ready):**
```bash
sudo /usr/local/share/hive/setup-ovn.sh --ovn-remote=tcp:$HIVE_NODE1:6642 --encap-ip=$HIVE_NODE3
sudo /usr/local/share/hive/setup-ovn.sh --ovn-remote=tcp:$SPINIFEX_NODE1:6642 --encap-ip=$SPINIFEX_NODE3
```
Verify all chassis have registered (from server 1):
@@ -121,11 +121,11 @@ The formation process requires running init and join commands concurrently. The
**Server 1 — Initialize the cluster:**
```bash
sudo hive admin init \
sudo spx admin init \
--node node1 \
--nodes 3 \
--bind $HIVE_NODE1 \
--cluster-bind $HIVE_NODE1 \
--bind $SPINIFEX_NODE1 \
--cluster-bind $SPINIFEX_NODE1 \
--port 4432 \
--region $AWS_REGION \
--az $AWS_AZ
@@ -134,11 +134,11 @@ sudo hive admin init \
**Server 2 — Join the cluster (while init is running):**
```bash
hive admin join \
spx admin join \
--node node2 \
--bind $HIVE_NODE2 \
--cluster-bind $HIVE_NODE2 \
--host $HIVE_NODE1:4432 \
--bind $SPINIFEX_NODE2 \
--cluster-bind $SPINIFEX_NODE2 \
--host $SPINIFEX_NODE1:4432 \
--region $AWS_REGION \
--az $AWS_AZ
```
@@ -146,11 +146,11 @@ hive admin join \
**Server 3 — Join the cluster (while init is running):**
```bash
hive admin join \
spx admin join \
--node node3 \
--bind $HIVE_NODE3 \
--cluster-bind $HIVE_NODE3 \
--host $HIVE_NODE1:4432 \
--bind $SPINIFEX_NODE3 \
--cluster-bind $SPINIFEX_NODE3 \
--host $SPINIFEX_NODE1:4432 \
--region $AWS_REGION \
--az $AWS_AZ
```
@@ -162,13 +162,13 @@ All three processes will exit with a cluster summary once formation is complete.
Start services on **all servers**:
```bash
sudo systemctl start hive.target
sudo systemctl start spinifex.target
```
From any node, verify the cluster:
```bash
hive get nodes
spx get nodes
```
```
@@ -183,9 +183,9 @@ node3 Ready 192.168.1.12 us-east-1 us-east-1a 2m 0
On **each server**, trust the CA generated during init:
```bash
sudo cp ~/hive/config/ca.pem /usr/local/share/ca-certificates/hive-ca.crt
sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates
export AWS_PROFILE=hive
export AWS_PROFILE=spinifex
```
## Step 7. Launch instances across the cluster
@@ -194,17 +194,17 @@ Connect to any node's AWS Gateway — all nodes serve the same cluster state:
```bash
aws ec2 run-instances \
--image-id $HIVE_AMI \
--image-id $SPINIFEX_AMI \
--instance-type t3.small \
--key-name hive-key \
--subnet-id $HIVE_SUBNET \
--key-name spinifex-key \
--subnet-id $SPINIFEX_SUBNET \
--count 3
```
Hive distributes instances across nodes based on available capacity. Check which node each instance landed on:
Spinifex distributes instances across nodes based on available capacity. Check which node each instance landed on:
```bash
hive get vms
spx get vms
```
## Shutdown
@@ -212,7 +212,7 @@ hive get vms
A graceful shutdown coordinates all nodes — drains VMs, flushes storage, and stops services:
```bash
hive admin cluster shutdown
spx admin cluster shutdown
```
## Troubleshooting
@@ -224,7 +224,7 @@ The init command must still be running when you execute join on other servers. I
Check that all servers can reach the init node on the formation port:
```bash
curl -s http://$HIVE_NODE1:4432/health
curl -s http://$SPINIFEX_NODE1:4432/health
```
## OVN chassis not registering
@@ -264,13 +264,13 @@ If tunnels are missing, verify `--encap-ip` was set correctly during OVN setup.
Check if the daemon is running and listening on the correct IP:
```bash
curl -s http://$HIVE_NODE1:4432/health
curl -s http://$SPINIFEX_NODE1:4432/health
```
Review the daemon logs for errors:
```bash
cat ~/hive/logs/daemon.log
cat ~/spinifex/logs/daemon.log
```
Verify `--bind` was set to the correct IP during cluster formation.
@@ -280,7 +280,7 @@ Verify `--bind` was set to the correct IP during cluster formation.
Check NATS logs for connection errors between nodes:
```bash
grep -i "route\|cluster" ~/hive/logs/nats.log
grep -i "route\|cluster" ~/spinifex/logs/nats.log
```
Ensure `--cluster-bind` IPs are reachable between all servers.
docs/installing-hive/README.md → docs/installing-spinifex/README.md
+33 -33
View File
@@ -1,6 +1,6 @@
---
title: "Installing Hive"
description: "Install Hive on a single server using the binary installer. Get a working region with EC2, VPC, EBS, and S3 in minutes."
title: "Installing Spinifex"
description: "Install Spinifex on a single server using the binary installer. Get a working region with EC2, VPC, EBS, and S3 in minutes."
category: "Getting Started"
tags:
- install
@@ -8,17 +8,17 @@ tags:
- quickstart
badge: quickstart
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
- title: "Predastore (S3)"
url: "https://github.com/mulgadc/predastore"
- title: "Viperblock (EBS)"
url: "https://github.com/mulgadc/viperblock"
---
# Installing Hive
# Installing Spinifex
> Install Hive on a single server using the binary installer.
> Install Spinifex on a single server using the binary installer.
## Table of Contents
@@ -30,16 +30,16 @@ resources:
## Overview
Hive is an open-source infrastructure platform that brings core AWS services — EC2, VPC, EBS, and S3 — to bare-metal, edge, and on-prem environments.
Spinifex is an open-source infrastructure platform that brings core AWS services — EC2, VPC, EBS, and S3 — to bare-metal, edge, and on-prem environments.
This guide installs Hive on a single server using the binary installer. For multi-server clusters, see [Multi-Node Installation](/docs/installing-hive-multi-node). To build from source, see [Source Install](/docs/source-install).
This guide installs Spinifex on a single server using the binary installer. For multi-server clusters, see [Multi-Node Installation](/docs/installing-hive-multi-node). To build from source, see [Source Install](/docs/source-install).
**Supported Operating Systems:**
- Ubuntu 22.04 / 24.04 / 25.10
- Debian 12.13
**What gets installed:**
- Hive daemon and CLI
- Spinifex daemon and CLI
- QEMU/KVM for virtual machine management
- OVN/Open vSwitch for VPC networking
- Predastore (S3-compatible object storage)
@@ -48,41 +48,41 @@ This guide installs Hive on a single server using the binary installer. For mult
## Instructions
## Step 1. Install Hive
## Step 1. Install Spinifex
```bash
curl https://install.mulgadc.com/ | bash
```
The installer downloads the Hive binary and bootstraps all dependencies (QEMU, OVN/OVS, AWS CLI).
The installer downloads the Spinifex binary and bootstraps all dependencies (QEMU, OVN/OVS, AWS CLI).
## Step 2. Initialize a region
Create your first region and availability zone, replace `ap-southeast-2` with your desired region:
```bash
hive admin init --region ap-southeast-2 --az ap-southeast-2a --node node1 --nodes 1
spx admin init --region ap-southeast-2 --az ap-southeast-2a --node node1 --nodes 1
```
## Step 3. Trust the CA certificate
Hive generates a local CA during initialization. Add it to your system trust store:
Spinifex generates a local CA during initialization. Add it to your system trust store:
```bash
sudo cp ~/hive/config/ca.pem /usr/local/share/ca-certificates/hive-ca.crt
sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates
```
## Step 4. Start services
```bash
sudo systemctl start hive.target
sudo systemctl start spinifex.target
```
Set the AWS profile to use the default admin account:
```bash
export AWS_PROFILE=hive
export AWS_PROFILE=spinifex
```
## Step 5. Import an AMI
@@ -90,26 +90,26 @@ export AWS_PROFILE=hive
List available images and import one matching your architecture:
```bash
hive admin images list
hive admin images import --name debian-12-arm64
spx admin images list
spx admin images import --name debian-12-arm64
```
## Step 6. Create a VPC and launch an instance
```bash
aws ec2 create-vpc --cidr-block 10.200.0.0/16
export HIVE_VPC="vpc-XXX"
export SPINIFEX_VPC="vpc-XXX"
aws ec2 create-subnet --vpc-id $HIVE_VPC --cidr-block 10.200.1.0/24
export HIVE_SUBNET="subnet-XXX"
aws ec2 create-subnet --vpc-id $SPINIFEX_VPC --cidr-block 10.200.1.0/24
export SPINIFEX_SUBNET="subnet-XXX"
aws ec2 import-key-pair --key-name "hive-key" --public-key-material fileb://~/.ssh/id_rsa.pub
aws ec2 import-key-pair --key-name "spinifex-key" --public-key-material fileb://~/.ssh/id_rsa.pub
aws ec2 run-instances \
--image-id $HIVE_AMI \
--image-id $SPINIFEX_AMI \
--instance-type t3.small \
--key-name hive-key \
--subnet-id $HIVE_SUBNET \
--key-name spinifex-key \
--subnet-id $SPINIFEX_SUBNET \
--count 1
```
@@ -121,7 +121,7 @@ Find the forwarded SSH port and connect:
ps auxw | grep hostfwd
# Look for: hostfwd=tcp:127.0.0.1:<port>-:22
ssh -i ~/.ssh/hive-key ec2-user@127.0.0.1 -p <port>
ssh -i ~/.ssh/spinifex-key ec2-user@127.0.0.1 -p <port>
```
## Troubleshooting
@@ -131,7 +131,7 @@ ssh -i ~/.ssh/hive-key ec2-user@127.0.0.1 -p <port>
The binary is not in your PATH. Run the installer again or add the install directory to your PATH:
```bash
export PATH=$PATH:~/hive/bin/
export PATH=$PATH:~/spinifex/bin/
```
Add this to your `~/.bashrc` or `~/.zshrc` for persistence.
@@ -153,26 +153,26 @@ journalctl -u ovn-controller --no-pager -n 20
## CA certificate not trusted
AWS CLI will reject HTTPS connections if the Hive CA is not trusted. Re-add the certificate:
AWS CLI will reject HTTPS connections if the Spinifex CA is not trusted. Re-add the certificate:
```bash
sudo cp ~/hive/config/ca.pem /usr/local/share/ca-certificates/hive-ca.crt
sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates
```
Verify it was added:
```bash
ls -la /usr/local/share/ca-certificates/hive-ca.crt
ls -la /usr/local/share/ca-certificates/spinifex-ca.crt
```
## Instance stuck in pending
Check the Hive daemon logs for errors:
Check the Spinifex daemon logs for errors:
```bash
ls ~/hive/logs/
cat ~/hive/logs/daemon.log
ls ~/spinifex/logs/
cat ~/spinifex/logs/daemon.log
```
Verify the AMI was imported successfully:
docs/launching-instances/README.md
+13 -13
View File
@@ -1,21 +1,21 @@
---
title: "Launching Instances"
description: "Launch, manage, and connect to EC2-compatible virtual machines on Hive."
description: "Launch, manage, and connect to EC2-compatible virtual machines on Spinifex."
category: "Environments"
tags:
- ec2
- instances
- vm
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
- title: "AWS EC2 CLI"
url: "https://docs.aws.amazon.com/cli/latest/reference/ec2/"
---
# Launching Instances
> Launch, manage, and connect to EC2-compatible virtual machines on Hive.
> Launch, manage, and connect to EC2-compatible virtual machines on Spinifex.
## Table of Contents
@@ -27,7 +27,7 @@ resources:
## Overview
Hive provides EC2-compatible VM management built on QEMU/KVM. Instances support cloud-init, SSH key injection, VPC networking, and standard AWS lifecycle operations.
Spinifex provides EC2-compatible VM management built on QEMU/KVM. Instances support cloud-init, SSH key injection, VPC networking, and standard AWS lifecycle operations.
**Supported operations:**
- `run-instances` — Launch new VMs
@@ -41,10 +41,10 @@ Hive provides EC2-compatible VM management built on QEMU/KVM. Instances support
```bash
aws ec2 run-instances \
--image-id $HIVE_AMI \
--image-id $SPINIFEX_AMI \
--instance-type t3.small \
--key-name hive-key \
--subnet-id $HIVE_SUBNET \
--key-name spinifex-key \
--subnet-id $SPINIFEX_SUBNET \
--count 1
export INSTANCE_ID="i-XXX"
@@ -63,7 +63,7 @@ aws ec2 terminate-instances --instance-ids $INSTANCE_ID
```bash
ps auxw | grep $INSTANCE_ID
ssh -i ~/.ssh/hive-key ec2-user@127.0.0.1 -p <port>
ssh -i ~/.ssh/spinifex-key ec2-user@127.0.0.1 -p <port>
```
## Troubleshooting
@@ -73,15 +73,15 @@ ssh -i ~/.ssh/hive-key ec2-user@127.0.0.1 -p <port>
Check QEMU logs for the instance and verify the AMI architecture matches your host:
```bash
cat ~/hive/logs/daemon.log
aws ec2 describe-images --image-ids $HIVE_AMI
cat ~/spinifex/logs/daemon.log
aws ec2 describe-images --image-ids $SPINIFEX_AMI
```
If the AMI is for a different architecture (e.g. arm64 on an x86_64 host), import the correct image:
```bash
./bin/hive admin images list
./bin/hive admin images import --name debian-12-x86_64
./bin/spx admin images list
./bin/spx admin images import --name debian-12-x86_64
```
## Cannot SSH into instance
docs/moving-aws-workload/README.md
+10 -10
View File
@@ -1,6 +1,6 @@
---
title: "Moving an AWS Workload to Mulga"
description: "Migrate existing AWS workloads to Hive using compatible APIs, SDKs, and Terraform."
description: "Migrate existing AWS workloads to Spinifex using compatible APIs, SDKs, and Terraform."
category: "Migration"
tags:
- migration
@@ -8,8 +8,8 @@ tags:
- terraform
badge: new
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
- title: "AWS CLI Reference"
url: "https://docs.aws.amazon.com/cli/latest/reference/"
- title: "Terraform AWS Provider"
@@ -18,7 +18,7 @@ resources:
# Moving an AWS Workload to Mulga
> Migrate existing AWS workloads to Hive using compatible APIs, SDKs, and Terraform.
> Migrate existing AWS workloads to Spinifex using compatible APIs, SDKs, and Terraform.
## Table of Contents
@@ -30,7 +30,7 @@ resources:
## Overview
Hive provides drop-in compatibility with AWS APIs, making it possible to migrate existing workloads with minimal changes.
Spinifex provides drop-in compatibility with AWS APIs, making it possible to migrate existing workloads with minimal changes.
**Supported Services:** VPC, EC2, EBS, S3, IAM
@@ -41,7 +41,7 @@ Hive provides drop-in compatibility with AWS APIs, making it possible to migrate
## Configure AWS CLI
```bash
export AWS_PROFILE=hive
export AWS_PROFILE=spinifex
aws ec2 describe-instances
aws s3 ls
```
@@ -51,8 +51,8 @@ aws s3 ls
```hcl
provider "aws" {
region = "ap-southeast-2"
access_key = "your-hive-access-key"
secret_key = "your-hive-secret-key"
access_key = "your-spinifex-access-key"
secret_key = "your-spinifex-secret-key"
endpoints {
ec2 = "https://localhost:9999"
@@ -68,7 +68,7 @@ provider "aws" {
## Hybrid S3 Sync
```bash
aws s3 sync s3://local-bucket/ s3://cloud-bucket/ --source-region hive --region us-east-1
aws s3 sync s3://local-bucket/ s3://cloud-bucket/ --source-region spinifex --region us-east-1
```
## Troubleshooting
@@ -87,7 +87,7 @@ Without these, Terraform will try to validate credentials and metadata against r
## S3 signature errors
Hive uses AWS Signature V4. Ensure your AWS CLI is version 2.0 or higher:
Spinifex uses AWS Signature V4. Ensure your AWS CLI is version 2.0 or higher:
```bash
aws --version
docs/source-install/README.md
+15 -15
View File
@@ -1,6 +1,6 @@
---
title: "Source Install"
description: "Build Hive from source for development, custom builds, or contributing. Includes dependency setup, compilation, and OVN configuration."
description: "Build Spinifex from source for development, custom builds, or contributing. Includes dependency setup, compilation, and OVN configuration."
category: "Getting Started"
tags:
- install
@@ -8,8 +8,8 @@ tags:
- development
badge: source
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
- title: "Predastore (S3)"
url: "https://github.com/mulgadc/predastore"
- title: "Viperblock (EBS)"
@@ -22,7 +22,7 @@ resources:
# Source Install
> Build Hive from source for development, custom builds, or contributing.
> Build Spinifex from source for development, custom builds, or contributing.
## Table of Contents
@@ -34,7 +34,7 @@ resources:
## Overview
This guide covers building Hive from source code. Use this if you want to contribute to Hive, build custom versions, or inspect the codebase. For production deployments, the [binary installer](/docs/installing-hive) is recommended.
This guide covers building Spinifex from source code. Use this if you want to contribute to Spinifex, build custom versions, or inspect the codebase. For production deployments, the [binary installer](/docs/installing-hive) is recommended.
**Supported Operating Systems:**
- Ubuntu 22.04 / 24.04 / 25.10
@@ -56,7 +56,7 @@ This guide covers building Hive from source code. Use this if you want to contri
Bootstrap all dependencies in one step:
```bash
sudo make -C hive quickinstall
sudo make -C spinifex quickinstall
```
Ensure Go is in your PATH:
@@ -94,13 +94,13 @@ aws --version
```bash
mkdir -p ~/Development/mulga/
cd ~/Development/mulga/
git clone https://github.com/mulgadc/hive.git
cd hive
git clone https://github.com/mulgadc/spinifex.git
cd spinifex
./scripts/clone-deps.sh # Clone viperblock + predastore
./scripts/dev-setup.sh # Setup complete dev environment
```
Confirm `./bin/hive` exists and is executable.
Confirm `./bin/spx` exists and is executable.
## Step 3. Setup OVN
@@ -117,13 +117,13 @@ This creates the `br-int` integration bridge, starts `ovn-controller`, configure
Create a region and availability zone:
```bash
./bin/hive admin init --region ap-southeast-2 --az ap-southeast-2a --node node1 --nodes 1
./bin/spx admin init --region ap-southeast-2 --az ap-southeast-2a --node node1 --nodes 1
```
## Step 5. Trust the CA certificate
```bash
sudo cp ~/hive/config/ca.pem /usr/local/share/ca-certificates/hive-ca.crt
sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates
```
@@ -131,7 +131,7 @@ sudo update-ca-certificates
```bash
./scripts/start-dev.sh
export AWS_PROFILE=hive
export AWS_PROFILE=spinifex
```
## Troubleshooting
@@ -150,7 +150,7 @@ Add this to your `~/.bashrc` or `~/.zshrc` for persistence. Verify with:
go version
```
## ./bin/hive missing after build
## ./bin/spx missing after build
The build did not complete successfully. Re-run the setup:
@@ -177,10 +177,10 @@ sudo ovn-sbctl show
## CA certificate not trusted
AWS CLI will reject HTTPS connections to Hive services. Re-add the certificate:
AWS CLI will reject HTTPS connections to Spinifex services. Re-add the certificate:
```bash
sudo cp ~/hive/config/ca.pem /usr/local/share/ca-certificates/hive-ca.crt
sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates
```
docs/hive-admin-cli/README.md → docs/spinifex-admin-cli/README.md
+19 -19
View File
@@ -1,6 +1,6 @@
---
title: "Hive Admin CLI"
description: "Complete reference for the Hive administration CLI. Manage accounts, nodes, VMs, and services."
title: "Spinifex Admin CLI"
description: "Complete reference for the Spinifex administration CLI. Manage accounts, nodes, VMs, and services."
category: "Administration"
tags:
- cli
@@ -8,13 +8,13 @@ tags:
- reference
badge: cli
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
---
# Hive Admin CLI
# Spinifex Admin CLI
> Complete reference for the Hive administration CLI.
> Complete reference for the Spinifex administration CLI.
## Table of Contents
@@ -26,25 +26,25 @@ resources:
## Overview
The `hive` binary is the central administration tool for managing your Hive infrastructure. It provides commands for cluster initialization, account management, node operations, VM lifecycle, and service control.
The `spx` binary is the central administration tool for managing your Spinifex infrastructure. It provides commands for cluster initialization, account management, node operations, VM lifecycle, and service control.
**Binary location:** `~/Development/mulga/hive/bin/hive`
**Binary location:** `~/Development/mulga/spinifex/bin/spx`
All services in the Hive platform are managed through this single binary.
All services in the Spinifex platform are managed through this single binary.
## Instructions
## Account Management
```bash
./bin/hive admin account create --name myteam
export AWS_PROFILE=hive-myteam
./bin/spx admin account create --name myteam
export AWS_PROFILE=spinifex-myteam
```
## Node Management
```bash
./bin/hive get nodes
./bin/spx get nodes
```
```
@@ -57,20 +57,20 @@ node3 Ready 127.0.0.3 ap-southeast-2 ap-southeast-2a 2m 0
## Monitor Resources
```bash
./bin/hive top nodes
./bin/spx top nodes
```
## Image Management
```bash
./bin/hive admin images list
./bin/hive admin images import --name debian-12-arm64
./bin/spx admin images list
./bin/spx admin images import --name debian-12-arm64
```
## Cluster Shutdown
```bash
./bin/hive admin cluster shutdown
./bin/spx admin cluster shutdown
```
## Troubleshooting
@@ -80,7 +80,7 @@ node3 Ready 127.0.0.3 ap-southeast-2 ap-southeast-2a 2m 0
The binary may not be executable. Fix permissions:
```bash
chmod +x ./bin/hive
chmod +x ./bin/spx
```
If you get permission errors during operations, ensure you're running with appropriate privileges. Some OVN and networking commands require `sudo`.
@@ -90,8 +90,8 @@ If you get permission errors during operations, ensure you're running with appro
Check the daemon logs for specific errors:
```bash
ls ~/hive/logs/
cat ~/hive/logs/daemon.log
ls ~/spinifex/logs/
cat ~/spinifex/logs/daemon.log
```
Common causes include port conflicts, missing OVN configuration, or untrusted CA certificates.
docs/vpc-networking/README.md
+7 -7
View File
@@ -7,8 +7,8 @@ tags:
- networking
- ovn
resources:
- title: "Hive Repository"
url: "https://github.com/mulgadc/hive"
- title: "Spinifex Repository"
url: "https://github.com/mulgadc/spinifex"
- title: "OVN Architecture"
url: "https://www.ovn.org/en/"
---
@@ -27,7 +27,7 @@ resources:
## Overview
Every EC2 instance runs inside a VPC with an isolated virtual network. Hive uses OVN (Open Virtual Network) to provide the networking layer.
Every EC2 instance runs inside a VPC with an isolated virtual network. Spinifex uses OVN (Open Virtual Network) to provide the networking layer.
**How it works:**
- VPC becomes an OVN logical router
@@ -41,14 +41,14 @@ Every EC2 instance runs inside a VPC with an isolated virtual network. Hive uses
```bash
aws ec2 create-vpc --cidr-block 10.200.0.0/16
export HIVE_VPC="vpc-XXX"
export SPINIFEX_VPC="vpc-XXX"
```
## Create Subnet
```bash
aws ec2 create-subnet --vpc-id $HIVE_VPC --cidr-block 10.200.1.0/24
export HIVE_SUBNET="subnet-XXX"
aws ec2 create-subnet --vpc-id $SPINIFEX_VPC --cidr-block 10.200.1.0/24
export SPINIFEX_SUBNET="subnet-XXX"
```
## Verify
@@ -73,7 +73,7 @@ sudo systemctl is-active ovn-controller
Check the vpcd logs for errors:
```bash
cat ~/hive/logs/vpcd.log
cat ~/spinifex/logs/vpcd.log
```
## Instances cannot reach each other
go.mod
+1 -1
View File
@@ -1,4 +1,4 @@
module github.com/mulgadc/hive
module github.com/mulgadc/spinifex
go 1.26.1
scripts/PERFORMANCE.md
+48 -48
View File
@@ -39,7 +39,7 @@ Reset services first to apply latest changes:
```sh
./scripts/stop-dev.sh
PPROF_ENABLED=1 PPROF_OUTPUT=/tmp/hive-vm.prof ./scripts/start-dev.sh
PPROF_ENABLED=1 PPROF_OUTPUT=/tmp/spinifex-vm.prof ./scripts/start-dev.sh
```
Once services are started, connect to the benchmarking VM
@@ -48,15 +48,15 @@ Once services are started, connect to the benchmarking VM
./scripts/run-bench.sh
```
This will run the benchmark listed in `./scripts/disk-performance.sh` and store the results in `/tmp/hive-vm-disk.log`
This will run the benchmark listed in `./scripts/disk-performance.sh` and store the results in `/tmp/spinifex-vm-disk.log`
The Linux `perf` tool is also used to benchmark the `nbdkit` process used to create the QEMU > disk > NBD > viperblock > predastore sequence, which is an important tool for debugging purposes. The results will be stored in `/tmp/hive-nbdkit-perf.data`
The Linux `perf` tool is also used to benchmark the `nbdkit` process used to create the QEMU > disk > NBD > viperblock > predastore sequence, which is an important tool for debugging purposes. The results will be stored in `/tmp/spinifex-nbdkit-perf.data`
### Analyze results
Place the output of `/tmp/hive-vm-disk.log` into the results section below, increment the VM-$ID as the test case, and provide a short description of the last changes that were benchmarked.
Place the output of `/tmp/spinifex-vm-disk.log` into the results section below, increment the VM-$ID as the test case, and provide a short description of the last changes that were benchmarked.
Store the benchmark file in `predastore-rewrite/tests/hive-vm$id.prof` for later analysis.
Store the benchmark file in `predastore-rewrite/tests/spinifex-vm$id.prof` for later analysis.
# Results
@@ -575,7 +575,7 @@ Disk stats (read/write):
## Root Cause: TLS Handshakes Per Request
**Profile analysis (`hive-vm.prof`) reveals 84% of CPU spent on TLS handshakes:**
**Profile analysis (`spinifex-vm.prof`) reveals 84% of CPU spent on TLS handshakes:**
```
84.06% crypto/tls.(*Conn).HandshakeContext ← 84% of CPU!
@@ -736,13 +736,13 @@ With many short-lived connections, ports stuck in TIME_WAIT can exhaust the rang
## Host Configuration (sysctl)
### Recommended Settings for Hive Host
### Recommended Settings for Spinifex Host
Create `/etc/sysctl.d/99-hive.conf`:
Create `/etc/sysctl.d/99-spinifex.conf`:
```bash
# =============================================================================
# Hive Platform - System Tuning for High-Connection Workloads
# Spinifex Platform - System Tuning for High-Connection Workloads
# =============================================================================
# -----------------------------------------------------------------------------
@@ -827,21 +827,21 @@ vm.dirty_background_ratio = 5
Apply settings:
```bash
sudo sysctl -p /etc/sysctl.d/99-hive.conf
sudo sysctl -p /etc/sysctl.d/99-spinifex.conf
```
### Process Limits (/etc/security/limits.conf)
```bash
# Add to /etc/security/limits.conf or /etc/security/limits.d/hive.conf
# Add to /etc/security/limits.conf or /etc/security/limits.d/spinifex.conf
# For predastore/hive user
hive soft nofile 1048576
hive hard nofile 1048576
hive soft nproc unlimited
hive hard nproc unlimited
hive soft memlock unlimited
hive hard memlock unlimited
# For predastore/spinifex user
spinifex soft nofile 1048576
spinifex hard nofile 1048576
spinifex soft nproc unlimited
spinifex hard nproc unlimited
spinifex soft memlock unlimited
spinifex hard memlock unlimited
# Or for all users (dev environments)
* soft nofile 1048576
@@ -891,7 +891,7 @@ MaxConnsPerHost: 64
IdleConnTimeout: 60 * time.Second
```
**sysctl:** Apply full 99-hive.conf settings.
**sysctl:** Apply full 99-spinifex.conf settings.
### Large Deployment (65-256 VMs)
@@ -1105,7 +1105,7 @@ client := &http.Client{
- [ ] Validate fix with fio benchmark (VM-4)
- [ ] Add predastore connection metrics endpoint
- [ ] Test with 8-VM deployment
- [ ] Create hive-tuning.sh script for automated sysctl configuration
- [ ] Create spinifex-tuning.sh script for automated sysctl configuration
- [ ] Add Prometheus metrics for connection tracking
---
@@ -1186,7 +1186,7 @@ After migrating predastore to net/http with HTTP/2 support, profiling still show
Additionally, logs showed **126K+ HTTP/1.1 requests** despite HTTP/2 being configured:
```bash
cat ~/hive/logs/predastore.log | grep "HTTP/1" | wc -l
cat ~/spinifex/logs/predastore.log | grep "HTTP/1" | wc -l
# 126277
```
@@ -1235,12 +1235,12 @@ All S3 clients across the codebase were updated:
| File | Purpose |
|------|---------|
| `viperblock/viperblock/backends/s3/s3.go` | Block storage S3 backend |
| `hive/s3client/s3client.go` | Hive S3 client |
| `hive/handlers/ec2/key/service_impl.go` | EC2 key pair operations |
| `hive/handlers/ec2/volume/service_impl.go` | EBS volume operations |
| `hive/handlers/ec2/image/service_impl.go` | AMI image operations |
| `hive/utils/utils.go` | Shared S3 client utility |
| `hive/cmd/hive/cmd/admin.go` | Admin CLI operations |
| `spinifex/s3client/s3client.go` | Spinifex S3 client |
| `spinifex/handlers/ec2/key/service_impl.go` | EC2 key pair operations |
| `spinifex/handlers/ec2/volume/service_impl.go` | EBS volume operations |
| `spinifex/handlers/ec2/image/service_impl.go` | AMI image operations |
| `spinifex/utils/utils.go` | Shared S3 client utility |
| `spinifex/cmd/spinifex/cmd/admin.go` | Admin CLI operations |
| `predastore/s3db/client.go` | S3DB distributed client |
### Complete HTTP/2 Client Pattern
@@ -1323,14 +1323,14 @@ After deploying the fix, verify HTTP/2 is working:
```bash
# Check predastore logs for HTTP/2 requests
grep "HTTP/2" ~/hive/logs/predastore.log | head
grep "HTTP/2" ~/spinifex/logs/predastore.log | head
# Count HTTP/1.1 vs HTTP/2 requests
echo "HTTP/1.1: $(grep -c 'HTTP/1' ~/hive/logs/predastore.log)"
echo "HTTP/2.0: $(grep -c 'HTTP/2' ~/hive/logs/predastore.log)"
echo "HTTP/1.1: $(grep -c 'HTTP/1' ~/spinifex/logs/predastore.log)"
echo "HTTP/2.0: $(grep -c 'HTTP/2' ~/spinifex/logs/predastore.log)"
# Profile should show minimal TLS overhead
go tool pprof -top hive-vm.prof | head -20
go tool pprof -top spinifex-vm.prof | head -20
# TLS functions should be <5% instead of 60-84%
```
@@ -1354,15 +1354,15 @@ go tool pprof -top hive-vm.prof | head -20
### Mandatory Testing Before Changes
The Hive platform consists of three interdependent repositories:
The Spinifex platform consists of three interdependent repositories:
```
hive ──depends on──► viperblock ──depends on──► predastore
spinifex ──depends on──► viperblock ──depends on──► predastore
```
**CRITICAL: All tests must pass across all three repositories before committing changes.**
Changes in predastore can break viperblock and hive. Changes in viperblock can break hive.
Changes in predastore can break viperblock and spinifex. Changes in viperblock can break spinifex.
### Testing Workflow
@@ -1375,8 +1375,8 @@ LOG_IGNORE=1 go test ./... -count=1
cd /path/to/viperblock
LOG_IGNORE=1 go test ./... -count=1
# 3. Finally test hive (depends on both)
cd /path/to/hive
# 3. Finally test spinifex (depends on both)
cd /path/to/spinifex
LOG_IGNORE=1 go test ./... -count=1
```
@@ -1384,7 +1384,7 @@ LOG_IGNORE=1 go test ./... -count=1
Each repository uses `go.work` for local development with replace directives:
**hive/go.work:**
**spinifex/go.work:**
```go
go 1.25.5
@@ -1423,7 +1423,7 @@ LOG_IGNORE=1 # Suppress log output during tests
- [ ] `cd predastore && go test ./...` passes
- [ ] `cd viperblock && go test ./...` passes
- [ ] `cd hive && go test ./...` passes
- [ ] `cd spinifex && go test ./...` passes
- [ ] `go build ./...` succeeds in all repos
- [ ] No new compiler warnings
@@ -1799,7 +1799,7 @@ go tool trace /tmp/trace.out
- `viperblock/viperblock/viperblock.go` - Core read/write logic (lines 1688-1856 for read path)
- `viperblock/nbd/viperblock.go` - NBD plugin interface
- `predastore-rewrite/tests/hive-vm7.prof` - Predastore profile (post-HTTP2 fix)
- `predastore-rewrite/tests/spinifex-vm7.prof` - Predastore profile (post-HTTP2 fix)
- `/tmp/nbdkit-perf2.data` - Viperblock perf profile
### References
@@ -1851,7 +1851,7 @@ The `mapassign_fast64` bottleneck has been completely eliminated:
| `crypto/md5.block` | 0.83% | AWS v4 signatures |
| `crypto/sha256` | 0.58% | TLS crypto |
**Predastore Server (hive-vm8.prof):**
**Predastore Server (spinifex-vm8.prof):**
| Function | CPU % | Category |
|----------|-------|----------|
@@ -2011,7 +2011,7 @@ Profile is now evenly distributed:
- `runtime.memclrNoHeapPointers`: 1.32%
- All other functions < 1.5%
### Predastore Profile (hive-vm9.prof) - Now the Bottleneck
### Predastore Profile (spinifex-vm9.prof) - Now the Bottleneck
| Function | CPU % | Category |
|----------|-------|----------|
@@ -2058,7 +2058,7 @@ These logs were firing on every operation, adding unnecessary overhead.
### Chi Middleware Logger Overhead
**Problem Identified:** The Go profile (hive-vm9.prof) showed significant overhead from chi's RequestLogger middleware:
**Problem Identified:** The Go profile (spinifex-vm9.prof) showed significant overhead from chi's RequestLogger middleware:
```
chi/v5/middleware.init.0.RequestLogger.func1.1 27.47s 17.39%
@@ -2166,11 +2166,11 @@ After deploying, run benchmark and verify:
```bash
# Profile should show no chi Logger overhead
go tool pprof -top hive-vm10.prof | grep -i logger
go tool pprof -top spinifex-vm10.prof | grep -i logger
# Expected: No results
# I/O should now dominate
go tool pprof -top hive-vm10.prof | head -10
go tool pprof -top spinifex-vm10.prof | head -10
# Expected: syscall.Syscall6 > 45%
```
@@ -2180,7 +2180,7 @@ go tool pprof -top hive-vm10.prof | head -10
### Profile Analysis
**Predastore (hive-vm10.prof):**
**Predastore (spinifex-vm10.prof):**
| Function | CPU % | Notes |
|----------|-------|-------|
| `syscall.Syscall6` | **37.32%** | I/O bound - expected |
@@ -2346,7 +2346,7 @@ The `UnifiedBlockStore` has `EvictCache()` method but no automatic LRU eviction
| File | Change |
|------|--------|
| `hive/services/viperblockd/viperblockd.go` | Fixed HasSuffix args, fixed cache logic |
| `spinifex/services/viperblockd/viperblockd.go` | Fixed HasSuffix args, fixed cache logic |
| `viperblock/viperblock/viperblock.go` | 8 read logs changed to Debug level |
### Expected Impact (VM-11)
@@ -2417,11 +2417,11 @@ if hitRate < 0.5 && cacheSize < maxCache {
```bash
# Check cache is enabled for main volumes
grep "Enabling 64MB cache" ~/hive/logs/viperblockd.log
grep "Enabling 64MB cache" ~/spinifex/logs/viperblockd.log
# Expected: One line per main volume
# Check cache disabled for auxiliary volumes
grep "Disabling cache for auxiliary" ~/hive/logs/viperblockd.log
grep "Disabling cache for auxiliary" ~/spinifex/logs/viperblockd.log
# Expected: Lines for *-cloudinit and *-efi volumes
# Monitor cache hit rate (if stats endpoint available)
scripts/clone-deps.sh
+4 -4
View File
@@ -1,6 +1,6 @@
#!/bin/bash
# Hive Development Dependencies Setup Script
# Spinifex Development Dependencies Setup Script
# This script clones Viperblock and Predastore repositories for cross-repo development
# TODO: Improve, remove CLAUDE readme reference, simplify next-steps
@@ -10,13 +10,13 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
MULGA_ROOT="$(cd "$PROJECT_ROOT/.." && pwd)"
echo "🏗️ Setting up Hive development environment..."
echo "🏗️ Setting up Spinifex development environment..."
echo "Project root: $PROJECT_ROOT"
echo "Mulga root: $MULGA_ROOT"
# Check if we're in the correct directory structure
if [[ ! -f "$PROJECT_ROOT/go.mod" ]]; then
echo "❌ Error: Cannot find go.mod. Please run this script from the hive repository."
echo "❌ Error: Cannot find go.mod. Please run this script from the spinifex repository."
exit 1
fi
@@ -70,7 +70,7 @@ fi
# Verify directory structure
echo ""
echo "📁 Directory structure:"
ls -la "$MULGA_ROOT" | grep -E "(hive|viperblock|predastore)" || true
ls -la "$MULGA_ROOT" | grep -E "(spinifex|viperblock|predastore)" || true
echo ""
echo "🎉 Development environment setup complete!"
scripts/coverage.sh
+2 -2
View File
@@ -3,12 +3,12 @@ set -euo pipefail
# Run Go tests with coverage and report total code coverage.
COVERPROFILE=$(mktemp /tmp/hive-coverage-XXXXXX.out)
COVERPROFILE=$(mktemp /tmp/spinifex-coverage-XXXXXX.out)
trap 'rm -f "$COVERPROFILE"' EXIT
echo "Running tests with coverage..."
echo ""
LOG_IGNORE=1 go test -timeout 120s -coverprofile="$COVERPROFILE" -covermode=atomic ./hive/... 2>&1
LOG_IGNORE=1 go test -timeout 120s -coverprofile="$COVERPROFILE" -covermode=atomic ./spinifex/... 2>&1
if [[ ! -s "$COVERPROFILE" ]]; then
echo "No coverage data collected."
scripts/create-multi-node.sh
+4 -4
View File
@@ -26,13 +26,13 @@ echo "========================="
echo "Starting init node (127.0.0.1) and joining nodes (127.0.0.2, 127.0.0.3)..."
# Init blocks until all nodes join, so run in background
./bin/hive admin init \
./bin/spx admin init \
--node node1 \
--nodes 3 \
--bind 127.0.0.1 \
--cluster-bind 127.0.0.1 \
--port 4432 \
--hive-dir ~/node1/ \
--spinifex-dir ~/node1/ \
--config-dir ~/node1/config/ \
--region ap-southeast-2 \
--az ap-southeast-2a &
@@ -42,7 +42,7 @@ INIT_PID=$!
sleep 2
# Join nodes concurrently
./bin/hive admin join \
./bin/spx admin join \
--node node2 \
--bind 127.0.0.2 \
--cluster-bind 127.0.0.2 \
@@ -53,7 +53,7 @@ sleep 2
--az ap-southeast-2a &
JOIN2_PID=$!
./bin/hive admin join \
./bin/spx admin join \
--node node3 \
--bind 127.0.0.3 \
--cluster-bind 127.0.0.3 \
scripts/dev-setup.sh
+24 -24
View File
@@ -1,7 +1,7 @@
#!/bin/bash
# Hive Platform Development Environment Setup
# This script sets up a complete development environment for the Hive platform
# Spinifex Platform Development Environment Setup
# This script sets up a complete development environment for the Spinifex platform
set -e
@@ -12,17 +12,17 @@ MULGA_ROOT="$(cd "$PROJECT_ROOT/.." && pwd)"
# Default configuration
NATS_PORT=4222
PREDASTORE_PORT=8443
HIVE_GATEWAY_PORT=9999
DATA_DIR="$HOME/hive"
# Use CONFIG_DIR environment variable if set, otherwise default to ~/hive/config
CONFIG_DIR="${CONFIG_DIR:-$HOME/hive/config}"
SPINIFEX_GATEWAY_PORT=9999
DATA_DIR="$HOME/spinifex"
# Use CONFIG_DIR environment variable if set, otherwise default to ~/spinifex/config
CONFIG_DIR="${CONFIG_DIR:-$HOME/spinifex/config}"
echo "🚀 Setting up Hive development environment..."
echo "🚀 Setting up Spinifex development environment..."
echo "Project root: $PROJECT_ROOT"
echo "Data directory: $DATA_DIR"
# Create necessary directories
mkdir -p "$DATA_DIR"/{nats,predastore,viperblock,logs,hive}
mkdir -p "$DATA_DIR"/{nats,predastore,viperblock,logs,spinifex}
mkdir -p "$CONFIG_DIR"
# Function to check if command exists
@@ -124,7 +124,7 @@ done
echo ""
echo "🔌 Checking port availability..."
ports=("$NATS_PORT:NATS" "$PREDASTORE_PORT:Predastore" "$HIVE_GATEWAY_PORT:Hive Gateway")
ports=("$NATS_PORT:NATS" "$PREDASTORE_PORT:Predastore" "$SPINIFEX_GATEWAY_PORT:Spinifex Gateway")
for port_info in "${ports[@]}"; do
port="${port_info%:*}"
service="${port_info#*:}"
@@ -135,24 +135,24 @@ for port_info in "${ports[@]}"; do
fi
done
# Build Hive first (needed for admin init)
# Build Spinifex first (needed for admin init)
echo ""
echo "🔨 Building Hive..."
echo "🔨 Building Spinifex..."
cd "$PROJECT_ROOT"
make build
echo "✅ Hive built successfully"
echo "✅ Spinifex built successfully"
# Initialize Hive configuration using admin init
# Initialize Spinifex configuration using admin init
#echo ""
#echo "🔐 Initializing Hive configuration..."
#echo "🔐 Initializing Spinifex configuration..."
#if [[ ! -f "$CONFIG_DIR/hive.toml" ]]; then
# echo "📋 Running hive admin init..."
# ./bin/hive admin init --config-dir "$CONFIG_DIR"
# echo "✅ Hive configuration initialized"
#if [[ ! -f "$CONFIG_DIR/spinifex.toml" ]]; then
# echo "📋 Running spx admin init..."
# ./bin/spx admin init --config-dir "$CONFIG_DIR"
# echo "✅ Spinifex configuration initialized"
#else
# echo "✅ Hive configuration already exists"
# echo " To re-initialize, run: ./bin/hive admin init --force"
# echo "✅ Spinifex configuration already exists"
# echo " To re-initialize, run: ./bin/spx admin init --force"
#fi
# Build components
@@ -182,9 +182,9 @@ fi
echo ""
echo "🎉 Development environment setup complete!"
echo ""
echo "When running Hive for the first time, run the init function to create the"
echo "When running Spinifex for the first time, run the init function to create the"
echo "default directories for data, config files and layout required."
echo "./bin/hive admin init"
echo "./bin/spx admin init"
echo ""
echo "🚀 To start the development environment:"
echo " ./scripts/start-dev.sh"
@@ -193,7 +193,7 @@ echo "🛑 To stop the development environment:"
echo " ./scripts/stop-dev.sh"
echo ""
echo "🔧 Development endpoints:"
echo " - Hive Gateway: https://localhost:$HIVE_GATEWAY_PORT"
echo " - Spinifex Gateway: https://localhost:$SPINIFEX_GATEWAY_PORT"
echo " - Predastore S3: https://localhost:$PREDASTORE_PORT"
echo " - NATS: nats://localhost:$NATS_PORT"
echo ""
@@ -201,4 +201,4 @@ echo "📊 Monitor logs:"
echo " tail -f $DATA_DIR/logs/*.log"
echo ""
echo "🧪 Test with AWS CLI:"
echo " aws --endpoint-url https://localhost:$HIVE_GATEWAY_PORT --no-verify-ssl ec2 describe-instances"
echo " aws --endpoint-url https://localhost:$SPINIFEX_GATEWAY_PORT --no-verify-ssl ec2 describe-instances"
scripts/iac/README.md
+3 -3
View File
@@ -1,9 +1,9 @@
# IAC
Collection of OpenTofu/Terraform templates for creating Hive instances.
Collection of OpenTofu/Terraform templates for creating Spinifex instances.
| Template | Description |
|---|---|
| [proxmox/](proxmox/) | Provisions a 3-node Hive cluster on Proxmox VE bare-metal hypervisors |
| [proxmox/](proxmox/) | Provisions a 3-node Spinifex cluster on Proxmox VE bare-metal hypervisors |
| [aws/](aws/) | Provisions infrastructure using the Terraform AWS provider, with MulgaOS AWS-compatible API as the local endpoint |
| [proxmox-template/](proxmox-template/) | Builds a Proxmox VM template with all Hive dependencies pre-installed (QEMU, Go, repos, modules) |
| [proxmox-template/](proxmox-template/) | Builds a Proxmox VM template with all Spinifex dependencies pre-installed (QEMU, Go, repos, modules) |
scripts/iac/aws/README.md
+9 -9
View File
@@ -14,7 +14,7 @@ This directory contains OpenTofu/Terraform configuration files for deploying inf
```
2. **MulgaOS services running**
- `hive daemon` - Core daemon with NATS subscriptions
- `spinifex daemon` - Core daemon with NATS subscriptions
- `awsd` - AWS API gateway (default: http://localhost:8080)
- `predastore` - S3-compatible storage
- `viperblock` - EBS-compatible block storage
@@ -26,14 +26,14 @@ This directory contains OpenTofu/Terraform configuration files for deploying inf
export AWS_SECRET_ACCESS_KEY=your_secret_key
# Option 2: AWS CLI profile
aws configure --profile hive
export AWS_PROFILE=hive
aws configure --profile spinifex
export AWS_PROFILE=spinifex
```
4. **AMI available**
Before running, ensure you have a Debian 12 AMI imported:
```bash
# Import an AMI using the hive CLI or aws CLI
# Import an AMI using the spinifex CLI or aws CLI
aws --endpoint-url http://localhost:8080 ec2 describe-images
```
@@ -106,7 +106,7 @@ The `main.tf` creates:
5. **Security Group** - Allows SSH (22), HTTP (80), HTTPS (443) inbound
6. **Placement Group** - Spread strategy for HA
7. **3 EC2 Instances** - t3.small Debian 12 VMs
8. **SSH Key Pair** - ED25519 key saved to `hive-test.pem`
8. **SSH Key Pair** - ED25519 key saved to `spinifex-test.pem`
## SSH Access
@@ -114,11 +114,11 @@ After `tofu apply`, SSH into instances:
```bash
# Using the generated key
ssh -i hive-test.pem admin@<public_ip>
ssh -i spinifex-test.pem admin@<public_ip>
# For local development with QEMU port forwarding
# Find the forwarded port from QEMU args (-netdev user,id=net0,hostfwd=tcp:127.0.0.1:PORT-:22)
ssh -p PORT -i hive-test.pem admin@127.0.0.1
ssh -p PORT -i spinifex-test.pem admin@127.0.0.1
```
## Troubleshooting
@@ -143,7 +143,7 @@ Ensure MulgaOS services are running:
curl http://localhost:8080/health
# Check daemon status
hive daemon status
spinifex daemon status
```
### "InvalidAction" errors
@@ -193,7 +193,7 @@ resource "aws_instance" "vm" {
| File | Description |
|------|-------------|
| `main.tf` | Main Terraform/OpenTofu configuration |
| `hive-test.pem` | Generated SSH private key (after apply) |
| `spinifex-test.pem` | Generated SSH private key (after apply) |
| `.terraform/` | Provider plugins (after init) |
| `terraform.tfstate` | State file (after apply) |
| `terraform.tfvars` | Custom variables (optional) |
scripts/iac/aws/main.tf
+12 -12
View File
@@ -79,19 +79,19 @@ data "aws_ami" "debian12" {
}
}
# Keypair: hive-test
# Keypair: spinifex-test
resource "tls_private_key" "hive_test" {
algorithm = "ED25519"
}
resource "aws_key_pair" "hive_test" {
key_name = "hive-test"
key_name = "spinifex-test"
public_key = tls_private_key.hive_test.public_key_openssh
}
# Save private key locally for SSH
resource "local_file" "hive_test_pem" {
filename = "${path.module}/hive-test.pem"
filename = "${path.module}/spinifex-test.pem"
content = tls_private_key.hive_test.private_key_openssh
file_permission = "0600"
}
@@ -103,7 +103,7 @@ resource "aws_vpc" "main" {
enable_dns_support = true
tags = {
Name = "hive-test-vpc"
Name = "spinifex-test-vpc"
}
}
@@ -112,7 +112,7 @@ resource "aws_internet_gateway" "igw" {
vpc_id = aws_vpc.main.id
tags = {
Name = "hive-test-igw"
Name = "spinifex-test-igw"
}
}
@@ -124,7 +124,7 @@ resource "aws_subnet" "public" {
map_public_ip_on_launch = true
tags = {
Name = "hive-test-public-subnet"
Name = "spinifex-test-public-subnet"
}
}
@@ -137,7 +137,7 @@ resource "aws_route_table" "public" {
}
tags = {
Name = "hive-test-public-rt"
Name = "spinifex-test-public-rt"
}
}
@@ -148,7 +148,7 @@ resource "aws_route_table_association" "public" {
# 3: Security group
resource "aws_security_group" "web_ssh" {
name = "hive-test-sg"
name = "spinifex-test-sg"
description = "Allow inbound 22,80,443; allow all outbound"
vpc_id = aws_vpc.main.id
@@ -185,13 +185,13 @@ resource "aws_security_group" "web_ssh" {
}
tags = {
Name = "hive-test-sg"
Name = "spinifex-test-sg"
}
}
# 4: Ensure 3 servers on different underlying hardware (spread placement group)
resource "aws_placement_group" "spread" {
name = "hive-test-spread"
name = "spinifex-test-spread"
strategy = "spread"
}
@@ -208,7 +208,7 @@ resource "aws_instance" "vm" {
placement_group = aws_placement_group.spread.name
tags = {
Name = "hive-test-vm-${count.index + 1}"
Name = "spinifex-test-vm-${count.index + 1}"
}
}
@@ -219,6 +219,6 @@ output "instance_public_ips" {
output "ssh_commands" {
value = [
for ip in aws_instance.vm[*].public_ip :
"ssh -i hive-test.pem admin@${ip}"
"ssh -i spinifex-test.pem admin@${ip}"
]
}
scripts/iac/configure-cluster.sh
+7 -7
View File
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
set -euo pipefail
# Configure a provisioned Hive cluster: clone repo, build, form cluster, start services.
# Configure a provisioned Spinifex cluster: clone repo, build, form cluster, start services.
# Usage: configure-cluster.sh <cluster_name> <state_file>
CLUSTER_NAME="${1:?Usage: configure-cluster.sh <cluster_name> <state_file>}"
@@ -93,7 +93,7 @@ NODE1_IP="${MGMT_IPS[0]}"
# Node 1: init
echo " Starting init on node1 ($NODE1_IP)..."
remote_bg "$NODE1_IP" "export PATH=\$PATH:/usr/local/go/bin && cd ~/Development/mulga/hive && ./bin/hive admin init \
remote_bg "$NODE1_IP" "export PATH=\$PATH:/usr/local/go/bin && cd ~/Development/mulga/hive && ./bin/spx admin init \
--node node1 \
--bind $NODE1_IP \
--cluster-bind $NODE1_IP \
@@ -103,8 +103,8 @@ remote_bg "$NODE1_IP" "export PATH=\$PATH:/usr/local/go/bin && cd ~/Development/
--nodes $NODE_COUNT \
--region $REGION \
--az $AZ \
--hive-dir ~/hive/ \
--config-dir ~/hive/config/"
--hive-dir ~/spinifex/ \
--config-dir ~/spinifex/config/"
INIT_PID=$!
# Wait for formation server to be ready
@@ -128,14 +128,14 @@ if [ "$NODE_COUNT" -gt 1 ]; then
ip="${MGMT_IPS[$i]}"
node_num=$((i + 1))
echo " Starting join on node$node_num ($ip)..."
remote_bg "$ip" "export PATH=\$PATH:/usr/local/go/bin && cd ~/Development/mulga/hive && ./bin/hive admin join \
remote_bg "$ip" "export PATH=\$PATH:/usr/local/go/bin && cd ~/Development/mulga/hive && ./bin/spx admin join \
--node node$node_num \
--bind $ip \
--cluster-bind $ip \
--cluster-routes $NODE1_IP:4248 \
--host $NODE1_IP:4432 \
--data-dir ~/hive/ \
--config-dir ~/hive/config/ \
--data-dir ~/spinifex/ \
--config-dir ~/spinifex/config/ \
--region $REGION \
--az $AZ"
JOIN_PIDS+=($!)
scripts/iac/proxmox-template/README.md
+5 -5
View File
@@ -1,6 +1,6 @@
# Hive Node Template Builder
# Spinifex Node Template Builder
Builds a Proxmox VM template with all Hive dependencies pre-installed. Cloning from this template reduces cluster spin-up from ~15 minutes to ~1-2 minutes (`git pull` + `make build`).
Builds a Proxmox VM template with all Spinifex dependencies pre-installed. Cloning from this template reduces cluster spin-up from ~15 minutes to ~1-2 minutes (`git pull` + `make build`).
## What's in the template
@@ -9,7 +9,7 @@ Builds a Proxmox VM template with all Hive dependencies pre-installed. Cloning f
| System packages | QEMU, nbdkit, libvirt, gcc, jq, curl, etc. (`make install-system`) |
| Go | 1.26.1 (`make install-go`) |
| AWS CLI | v2 (`make install-aws`) |
| Repositories | hive, viperblock, predastore (with `go.work` configured) |
| Repositories | spinifex, viperblock, predastore (with `go.work` configured) |
| Module cache | `go mod download` completed for all repos |
| Cloud images | Ubuntu 24.04 for nested VMs (`~/images/ubuntu-24.04.img`) |
| Tuning | sysctl (rmem_max/wmem_max), kvm group, ufw disabled |
@@ -65,12 +65,12 @@ On each cloned VM after boot:
```bash
# Pull latest code
cd ~/Development/mulga/hive && git pull
cd ~/Development/mulga/spinifex && git pull
cd ~/Development/mulga/viperblock && git pull
cd ~/Development/mulga/predastore && git pull
# Build (~30s with cached modules)
cd ~/Development/mulga/hive && export PATH=/usr/local/go/bin:$PATH && make build
cd ~/Development/mulga/spinifex && export PATH=/usr/local/go/bin:$PATH && make build
```
## Testing a Different Base Image
scripts/iac/proxmox/README.md
+13 -13
View File
@@ -1,6 +1,6 @@
# Proxmox IaC
OpenTofu/Terraform templates for provisioning Hive development clusters on Proxmox VE.
OpenTofu/Terraform templates for provisioning Spinifex development clusters on Proxmox VE.
## Prerequisites
@@ -12,9 +12,9 @@ OpenTofu/Terraform templates for provisioning Hive development clusters on Proxm
- SSH keypair for cloud-init VM access
- A hardcoded Debian ISO is used, which needs to be pre-installed on each Proxmox host ("debian-12-genericcloud-amd64-20240211-1654.img") https://cdimage.debian.org/images/cloud/bookworm/20240211-1654/debian-12-genericcloud-amd64-20240211-1654.qcow2
## Quick Start (hive-test.sh)
## Quick Start (spinifex-test.sh)
The `hive-test.sh` wrapper script manages the full lifecycle: provision, configure, test, and destroy.
The `spinifex-test.sh` wrapper script manages the full lifecycle: provision, configure, test, and destroy.
```sh
# Source environment
@@ -22,25 +22,25 @@ source scripts/iac/proxmox/.env
source ~/prox # Proxmox API token
# Provision a 3-node cluster
./scripts/iac/hive-test.sh up my-cluster
./scripts/iac/spinifex-test.sh up my-cluster
# Configure: clone repo, build, form cluster, start services
./scripts/iac/hive-test.sh configure my-cluster
./scripts/iac/spinifex-test.sh configure my-cluster
# Run smoke tests
./scripts/iac/hive-test.sh test my-cluster
./scripts/iac/spinifex-test.sh test my-cluster
# Check cluster health
./scripts/iac/hive-test.sh status my-cluster
./scripts/iac/spinifex-test.sh status my-cluster
# SSH to a specific node
./scripts/iac/hive-test.sh ssh my-cluster 2
./scripts/iac/spinifex-test.sh ssh my-cluster 2
# Destroy when done
./scripts/iac/hive-test.sh down my-cluster
./scripts/iac/spinifex-test.sh down my-cluster
# Or run the full lifecycle (up → configure → test → down)
./scripts/iac/hive-test.sh full my-cluster
./scripts/iac/spinifex-test.sh full my-cluster
```
### Options
@@ -55,7 +55,7 @@ source ~/prox # Proxmox API token
Example with custom sizing:
```sh
./scripts/iac/hive-test.sh up my-cluster --node-count=5 --memory-mb=8192 --cpu-cores=2
./scripts/iac/spinifex-test.sh up my-cluster --node-count=5 --memory-mb=8192 --cpu-cores=2
```
Per-cluster state is stored in `scripts/iac/proxmox/clusters/<name>/terraform.tfstate`, allowing multiple clusters to coexist.
@@ -185,7 +185,7 @@ ssh -i ~/.ssh/your-cloud-init-key tf-user@<VM_IP>
## Known issues
- `~/hive/config/hive.toml` - Does not add node1, node2, node3 from config automatically
- `~/hive/config/predastore/predastore.toml` - Uses previous static local node config, needs to use the IPs for each node in the cluster
- `~/spinifex/config/spinifex.toml` - Does not add node1, node2, node3 from config automatically
- `~/spinifex/config/predastore/predastore.toml` - Uses previous static local node config, needs to use the IPs for each node in the cluster
- On multi-node deployments, NATS on the primary can timeout waiting for other nodes to start, causing a race condition where NATS fails and all dependent services fail
- When adding 3 nodes, `nats.conf` is not updated with the 3rd node. Each node's cluster name is hardcoded to `C1` instead of per-node names
scripts/iac/proxmox/variables.tf
+2 -2
View File
@@ -62,7 +62,7 @@ variable "nodes" {
variable "cluster_name" {
type = string
description = "Name for the Hive cluster (used in VM names and tags)"
description = "Name for the Spinifex cluster (used in VM names and tags)"
validation {
condition = can(regex("^[a-z0-9-]+$", var.cluster_name))
@@ -72,7 +72,7 @@ variable "cluster_name" {
variable "node_count" {
type = number
description = "Number of Hive VMs to create"
description = "Number of Spinifex VMs to create"
default = 3
validation {
scripts/iac/proxmox/vms.tf
+1 -1
View File
@@ -3,7 +3,7 @@ resource "proxmox_virtual_environment_vm" "hive_node" {
name = "${var.cluster_name}-${count.index + 1}"
description = "Managed by Terraform"
tags = ["terraform", "hive", var.cluster_name]
tags = ["terraform", "spinifex", var.cluster_name]
node_name = var.nodes[count.index % length(var.nodes)].name
initialization {
scripts/iac/hive-test.sh → scripts/iac/spinifex-test.sh
+9 -9
View File
@@ -7,7 +7,7 @@ CLUSTERS_DIR="$TOFU_DIR/clusters"
usage() {
cat <<'USAGE'
Usage: hive-test.sh <command> <cluster_name> [options]
Usage: spinifex-test.sh <command> <cluster_name> [options]
Commands:
up Provision VMs with OpenTofu
@@ -25,13 +25,13 @@ Options:
--disk-size-gb=N Disk size per VM in GB (default: 32)
Examples:
./scripts/iac/hive-test.sh up hive-test1
./scripts/iac/hive-test.sh configure hive-test1
./scripts/iac/hive-test.sh test hive-test1
./scripts/iac/hive-test.sh status hive-test1
./scripts/iac/hive-test.sh ssh hive-test1 2
./scripts/iac/hive-test.sh down hive-test1
./scripts/iac/hive-test.sh full hive-test1 --node-count=3
./scripts/iac/spinifex-test.sh up spinifex-test1
./scripts/iac/spinifex-test.sh configure spinifex-test1
./scripts/iac/spinifex-test.sh test spinifex-test1
./scripts/iac/spinifex-test.sh status spinifex-test1
./scripts/iac/spinifex-test.sh ssh spinifex-test1 2
./scripts/iac/spinifex-test.sh down spinifex-test1
./scripts/iac/spinifex-test.sh full spinifex-test1 --node-count=3
USAGE
exit 1
}
@@ -195,7 +195,7 @@ cmd_status() {
cmd_ssh() {
if [ -z "$SSH_NODE" ]; then
echo "Usage: hive-test.sh ssh <cluster_name> <node_number>"
echo "Usage: spinifex-test.sh ssh <cluster_name> <node_number>"
exit 1
fi
scripts/iac/test-cluster.sh
+1 -1
View File
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
set -euo pipefail
# Run smoke tests against a configured Hive cluster.
# Run smoke tests against a configured Spinifex cluster.
# Usage: test-cluster.sh <cluster_name> <state_file>
CLUSTER_NAME="${1:?Usage: test-cluster.sh <cluster_name> <state_file>}"
scripts/reset-dev-env.sh
+9 -9
View File
@@ -8,26 +8,26 @@ echo "Shutting down services"
echo "Removing data"
rm -rf ~/hive/predastore/
rm -rf ~/spinifex/predastore/
rm -rf ~/hive/hive/*
rm -rf ~/spinifex/hive/*
rm -rf ~/hive/viperblock/*
rm -rf ~/spinifex/viperblock/*
rm -rf ~/hive/nats/*
rm -rf ~/spinifex/nats/*
rm -rf ~/hive/images/*
rm -rf ~/spinifex/images/*
# Enable pprof for development
PPROF_ENABLED=1 PPROF_OUTPUT=/tmp/hive-vm.prof ./scripts/start-dev.sh --build
PPROF_ENABLED=1 PPROF_OUTPUT=/tmp/spinifex-vm.prof ./scripts/start-dev.sh --build
# Follow INSTALL.md steps
echo "Importing AMI"
export AWS_PROFILE=hive
export AWS_PROFILE=spinifex
# Step 1 SSH key
aws ec2 import-key-pair --key-name "hive-key" --public-key-material fileb://~/.ssh/hive-key.pub
aws ec2 import-key-pair --key-name "spinifex-key" --public-key-material fileb://~/.ssh/spinifex-key.pub
echo "Validating key pair imported"
@@ -45,7 +45,7 @@ else
fi
echo "Detected architecture: $ARCH, using image: $IMAGE_NAME"
./bin/hive admin images import --name "$IMAGE_NAME"
./bin/spx admin images import --name "$IMAGE_NAME"
aws ec2 describe-images
scripts/run-bench.sh
+25 -25
View File
@@ -1,15 +1,15 @@
#!/bin/sh
# List running instances using ubuntu image and run disk performance benchmark
export AWS_PROFILE=hive
export AWS_PROFILE=spinifex
# Initialize perf tracking variables
PERF_PID=""
NBDKIT_PID=""
# Check HIVE_AMI set, if not try to detect it
if [ -z "$HIVE_AMI" ]; then
echo "HIVE_AMI not set, attempting to detect..."
# Check SPINIFEX_AMI set, if not try to detect it
if [ -z "$SPINIFEX_AMI" ]; then
echo "SPINIFEX_AMI not set, attempting to detect..."
ARCH=$(uname -m)
if [ "$ARCH" = "x86_64" ]; then
IMAGE_NAME="ami-ubuntu-24.04-x86_64"
@@ -18,23 +18,23 @@ if [ -z "$HIVE_AMI" ]; then
else
IMAGE_NAME="ami-ubuntu-24.04-x86_64"
fi
HIVE_AMI=$(aws ec2 describe-images --query "Images[?Name=='$IMAGE_NAME'].ImageId" --output text)
if [ -z "$HIVE_AMI" ]; then
SPINIFEX_AMI=$(aws ec2 describe-images --query "Images[?Name=='$IMAGE_NAME'].ImageId" --output text)
if [ -z "$SPINIFEX_AMI" ]; then
echo "Error: Could not find image with Name '$IMAGE_NAME'"
exit 1
fi
echo "Detected HIVE_AMI: $HIVE_AMI"
echo "Detected SPINIFEX_AMI: $SPINIFEX_AMI"
fi
# Get running instances matching the AMI
# Retry loop: wait for instance to come online (up to 120 seconds)
echo "Finding running instances with ImageId: $HIVE_AMI"
echo "Finding running instances with ImageId: $SPINIFEX_AMI"
MAX_ATTEMPTS=120
ATTEMPT=0
INSTANCE_ID=""
while [ $ATTEMPT -lt $MAX_ATTEMPTS ]; do
INSTANCE_JSON=$(aws ec2 describe-instances --filters "Name=image-id,Values=$HIVE_AMI" "Name=instance-state-name,Values=running" --output json 2>/dev/null)
INSTANCE_JSON=$(aws ec2 describe-instances --filters "Name=image-id,Values=$SPINIFEX_AMI" "Name=instance-state-name,Values=running" --output json 2>/dev/null)
# Extract InstanceId using jq (handle nested structure)
INSTANCE_ID=$(echo "$INSTANCE_JSON" | jq -r '.Reservations[0].Instances[0].InstanceId // empty' 2>/dev/null)
@@ -52,7 +52,7 @@ while [ $ATTEMPT -lt $MAX_ATTEMPTS ]; do
done
if [ -z "$INSTANCE_ID" ] || [ "$INSTANCE_ID" = "null" ]; then
echo "Error: No running instances found with ImageId $HIVE_AMI after $MAX_ATTEMPTS attempts"
echo "Error: No running instances found with ImageId $SPINIFEX_AMI after $MAX_ATTEMPTS attempts"
echo "Available instances:"
aws ec2 describe-instances --query "Reservations[*].Instances[*].[InstanceId,ImageId,State.Name]" --output table
exit 1
@@ -113,7 +113,7 @@ else
# Start perf record in the background (will run until interrupted)
echo "Starting perf profiling for nbdkit process (PID: $NBDKIT_PID)..."
sudo perf record -g -p "$NBDKIT_PID" -o /tmp/hive-nbdkit-perf.data > /tmp/perf.log 2>&1 &
sudo perf record -g -p "$NBDKIT_PID" -o /tmp/spinifex-nbdkit-perf.data > /tmp/perf.log 2>&1 &
PERF_PID=$!
echo "Perf profiling started (PID: $PERF_PID), will record during benchmark execution"
fi
@@ -137,7 +137,7 @@ SSH_READY=false
while [ $SSH_ATTEMPTS -lt $MAX_SSH_ATTEMPTS ]; do
ssh-keyscan -p "$SSH_PORT" 127.0.0.1 >> ~/.ssh/known_hosts 2>/dev/null
if ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o ConnectTimeout=2 -p "$SSH_PORT" -i ~/.ssh/hive-key ec2-user@127.0.0.1 'echo ready' >/dev/null 2>&1; then
if ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o ConnectTimeout=2 -p "$SSH_PORT" -i ~/.ssh/spinifex-key ec2-user@127.0.0.1 'echo ready' >/dev/null 2>&1; then
SSH_READY=true
echo "SSH is ready!"
break
@@ -156,7 +156,7 @@ if [ "$SSH_READY" != "true" ]; then
fi
echo "Copying benchmark script to instance..."
scp -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -P "$SSH_PORT" -i ~/.ssh/hive-key "$BENCH_SCRIPT" ec2-user@127.0.0.1:~/disk-performance.sh
scp -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -P "$SSH_PORT" -i ~/.ssh/spinifex-key "$BENCH_SCRIPT" ec2-user@127.0.0.1:~/disk-performance.sh
if [ $? -ne 0 ]; then
echo "Error: Failed to copy benchmark script to instance"
@@ -165,19 +165,19 @@ fi
# Execute benchmark script
echo "Running benchmark on instance..."
ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -p "$SSH_PORT" -i ~/.ssh/hive-key ec2-user@127.0.0.1 'chmod +x ~/disk-performance.sh && ~/disk-performance.sh' > /tmp/hive-vm-disk.log 2>&1
ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -p "$SSH_PORT" -i ~/.ssh/spinifex-key ec2-user@127.0.0.1 'chmod +x ~/disk-performance.sh && ~/disk-performance.sh' > /tmp/spinifex-vm-disk.log 2>&1
if [ $? -ne 0 ]; then
echo "Error: Benchmark execution failed, check /tmp/hive-vm-disk.log for details"
echo "Error: Benchmark execution failed, check /tmp/spinifex-vm-disk.log for details"
# Stop perf if it was running
if [ -n "$PERF_PID" ]; then
echo "Stopping perf profiling..."
sudo kill -INT "$PERF_PID" 2>/dev/null || true
# Wait for perf to finish writing
sleep 3
if [ -f /tmp/hive-nbdkit-perf.data ]; then
sudo chmod 644 /tmp/hive-nbdkit-perf.data
echo "Perf data saved to /tmp/hive-nbdkit-perf.data"
if [ -f /tmp/spinifex-nbdkit-perf.data ]; then
sudo chmod 644 /tmp/spinifex-nbdkit-perf.data
echo "Perf data saved to /tmp/spinifex-nbdkit-perf.data"
fi
fi
exit 1
@@ -191,19 +191,19 @@ if [ -n "$PERF_PID" ]; then
# Wait for perf to finish writing data
sleep 3
if [ -f /tmp/hive-nbdkit-perf.data ]; then
sudo chmod 644 /tmp/hive-nbdkit-perf.data
echo "Perf benchmarks saved to /tmp/hive-nbdkit-perf.data"
echo "To view: sudo perf report -i /tmp/hive-nbdkit-perf.data"
if [ -f /tmp/spinifex-nbdkit-perf.data ]; then
sudo chmod 644 /tmp/spinifex-nbdkit-perf.data
echo "Perf benchmarks saved to /tmp/spinifex-nbdkit-perf.data"
echo "To view: sudo perf report -i /tmp/spinifex-nbdkit-perf.data"
else
echo "Warning: Perf data file not found at /tmp/hive-nbdkit-perf.data"
echo "Warning: Perf data file not found at /tmp/spinifex-nbdkit-perf.data"
fi
fi
# Display results
echo ""
echo "Benchmark completed successfully!"
echo "Results saved to /tmp/hive-vm-disk.log"
echo "Results saved to /tmp/spinifex-vm-disk.log"
echo ""
echo "=== Benchmark Results ==="
cat /tmp/hive-vm-disk.log
cat /tmp/spinifex-vm-disk.log
scripts/run-instance.sh
+9 -9
View File
@@ -1,7 +1,7 @@
#!/bin/sh
# Query images, get Ubuntu image
export AWS_PROFILE=hive
export AWS_PROFILE=spinifex
# Detect architecture
ARCH=$(uname -m)
@@ -14,7 +14,7 @@ else
IMAGE_NAME="ami-ubuntu-24.04-x86_64"
fi
# Query available instance types from Hive and pick the first micro type
# Query available instance types from Spinifex and pick the first micro type
INSTANCE_TYPE=$(aws ec2 describe-instance-types --query "InstanceTypes[?contains(InstanceType, '.micro')].InstanceType | [0]" --output text)
if [ -z "$INSTANCE_TYPE" ] || [ "$INSTANCE_TYPE" = "None" ]; then
echo "Error: Could not find available micro instance type"
@@ -28,27 +28,27 @@ echo "Detected architecture: $ARCH"
echo "Looking for image with Name: $IMAGE_NAME"
# Query images and extract ImageId matching the IMAGE_NAME
HIVE_AMI=$(aws ec2 describe-images --query "Images[?Name=='$IMAGE_NAME'].ImageId" --output text)
SPINIFEX_AMI=$(aws ec2 describe-images --query "Images[?Name=='$IMAGE_NAME'].ImageId" --output text)
if [ -z "$HIVE_AMI" ]; then
if [ -z "$SPINIFEX_AMI" ]; then
echo "Error: Could not find image with Name '$IMAGE_NAME'"
echo "Available images:"
aws ec2 describe-images --query "Images[*].[Name,ImageId]" --output table
exit 1
fi
export HIVE_AMI=$HIVE_AMI
export SPINIFEX_AMI=$SPINIFEX_AMI
echo "Found ImageId: $HIVE_AMI"
export HIVE_AMI
echo "Found ImageId: $SPINIFEX_AMI"
export SPINIFEX_AMI
echo "Launching instance"
# Launch instance
aws ec2 run-instances \
--image-id "$HIVE_AMI" \
--image-id "$SPINIFEX_AMI" \
--instance-type "$INSTANCE_TYPE" \
--key-name hive-key \
--key-name spinifex-key \
--security-group-ids sg-0123456789abcdef0 \
--subnet-id subnet-6e7f829e \
--count 1
scripts/setup-ovn.sh
+10 -10
View File
@@ -1,6 +1,6 @@
#!/bin/bash
# OVN Compute Node Setup for Hive VPC Networking
# OVN Compute Node Setup for Spinifex VPC Networking
#
# This script bootstraps a compute node for OVN-based VPC networking:
# 1. Installs OVN/OVS packages (if not present)
@@ -71,7 +71,7 @@ if [ -z "$CHASSIS_ID" ]; then
echo "Auto-detected chassis ID: $CHASSIS_ID"
fi
echo "=== Hive OVN Compute Node Setup ==="
echo "=== Spinifex OVN Compute Node Setup ==="
echo " Management node: $MANAGEMENT"
echo " OVN Remote (SB): $OVN_REMOTE"
echo " Encap IP: $ENCAP_IP"
@@ -161,8 +161,8 @@ echo " ovn-controller: started"
echo ""
echo "Step 6: Applying sysctl for overlay networking..."
sudo tee /etc/sysctl.d/99-hive-vpc.conf >/dev/null <<'SYSCTL'
# Hive VPC networking: enable IP forwarding and disable rp_filter
sudo tee /etc/sysctl.d/99-spinifex-vpc.conf >/dev/null <<'SYSCTL'
# Spinifex VPC networking: enable IP forwarding and disable rp_filter
# for Geneve overlay traffic on OVS bridges.
net.ipv4.ip_forward=1
net.ipv4.conf.all.rp_filter=0
@@ -226,9 +226,9 @@ fi
# Create persistent systemd override so permissions survive OVS restarts
OVERRIDE_DIR="/etc/systemd/system/openvswitch-switch.service.d"
if [ ! -f "$OVERRIDE_DIR/hive-perms.conf" ]; then
if [ ! -f "$OVERRIDE_DIR/spinifex-perms.conf" ]; then
sudo mkdir -p "$OVERRIDE_DIR"
sudo tee "$OVERRIDE_DIR/hive-perms.conf" >/dev/null <<'OVERRIDE'
sudo tee "$OVERRIDE_DIR/spinifex-perms.conf" >/dev/null <<'OVERRIDE'
[Service]
ExecStartPost=/bin/chmod 0666 /var/run/openvswitch/db.sock
OVERRIDE
@@ -240,11 +240,11 @@ fi
# Create sudoers rule for network commands that always need root
# (ip tuntap, ip link set — NET_ADMIN operations)
SUDOERS_FILE="/etc/sudoers.d/hive-network"
SUDOERS_FILE="/etc/sudoers.d/spinifex-network"
if [ ! -f "$SUDOERS_FILE" ]; then
CURRENT_USER=$(whoami)
sudo tee "$SUDOERS_FILE" >/dev/null <<EOF
# Hive VPC networking: allow non-root daemon to manage tap devices and OVS
# Spinifex VPC networking: allow non-root daemon to manage tap devices and OVS
$CURRENT_USER ALL=(root) NOPASSWD: /sbin/ip, /usr/sbin/ip
$CURRENT_USER ALL=(root) NOPASSWD: /usr/bin/ovs-vsctl, /usr/bin/ovs-appctl
$CURRENT_USER ALL=(root) NOPASSWD: /usr/bin/ovn-nbctl, /usr/bin/ovn-sbctl
@@ -269,7 +269,7 @@ if ls /var/log/ovn/*.log.log* 1>/dev/null 2>&1; then
echo " cleaned up stale .log.log files"
fi
LOGROTATE_FILE="/etc/logrotate.d/ovn-hive"
LOGROTATE_FILE="/etc/logrotate.d/ovn-spinifex"
sudo tee "$LOGROTATE_FILE" >/dev/null <<'LOGROTATE'
/var/log/ovn/ovn-controller.log
/var/log/ovn/ovn-northd.log
@@ -288,7 +288,7 @@ LOGROTATE
echo " logrotate config: $LOGROTATE_FILE (daily, 100M max, 3 rotations, explicit filenames)"
# --- Step 10: Disable auto-start on boot ---
# start-dev.sh / stop-dev.sh manage the OVN lifecycle. Without hive services
# start-dev.sh / stop-dev.sh manage the OVN lifecycle. Without spinifex services
# running, ovn-controller spins in a tight reconnect loop burning CPU.
echo ""
echo "Step 10: Disabling OVN auto-start on boot (start-dev.sh will manage lifecycle)..."
scripts/setup.sh
+94 -94
View File
@@ -1,17 +1,17 @@
#!/bin/bash
# Hive binary installer
# Spinifex binary installer
# Usage: curl -sfL https://install.mulgadc.com | bash
#
# Environment variables:
# INSTALL_HIVE_CHANNEL Release channel: latest (default), dev
# INSTALL_HIVE_VERSION Pin to specific version (overrides channel)
# INSTALL_HIVE_TARBALL Path to local tarball (skips download, for testing/air-gapped)
# INSTALL_HIVE_SKIP_APT Set to 1 to skip apt dependency install
# INSTALL_HIVE_SKIP_AWS Set to 1 to skip AWS CLI install
# INSTALL_SPINIFEX_CHANNEL Release channel: latest (default), dev
# INSTALL_SPINIFEX_VERSION Pin to specific version (overrides channel)
# INSTALL_SPINIFEX_TARBALL Path to local tarball (skips download, for testing/air-gapped)
# INSTALL_SPINIFEX_SKIP_APT Set to 1 to skip apt dependency install
# INSTALL_SPINIFEX_SKIP_AWS Set to 1 to skip AWS CLI install
set -e
INSTALL_HIVE_CHANNEL="${INSTALL_HIVE_CHANNEL:-latest}"
INSTALL_SPINIFEX_CHANNEL="${INSTALL_SPINIFEX_CHANNEL:-latest}"
INSTALL_BASE_URL="${INSTALL_BASE_URL:-https://install.mulgadc.com}"
# --- Colors ---
@@ -60,7 +60,7 @@ detect_os() {
fi
;;
*)
fatal "Unsupported OS: $ID $VERSION_ID. Hive requires Debian 12+ or Ubuntu 22.04+"
fatal "Unsupported OS: $ID $VERSION_ID. Spinifex requires Debian 12+ or Ubuntu 22.04+"
;;
esac
@@ -82,7 +82,7 @@ detect_arch() {
AWS_ARCH="aarch64"
;;
*)
fatal "Unsupported architecture: $MACHINE. Hive requires x86_64 or aarch64"
fatal "Unsupported architecture: $MACHINE. Spinifex requires x86_64 or aarch64"
;;
esac
@@ -92,30 +92,30 @@ detect_arch() {
# --- Detect service user ---
detect_service_user() {
# Use the real user — either the current user, or SUDO_USER if running via sudo
HIVE_USER="${SUDO_USER:-$(whoami)}"
HIVE_GROUP="$(id -gn "$HIVE_USER")"
SPINIFEX_USER="${SUDO_USER:-$(whoami)}"
SPINIFEX_GROUP="$(id -gn "$SPINIFEX_USER")"
if [ "$HIVE_USER" = "root" ]; then
if [ "$SPINIFEX_USER" = "root" ]; then
fatal "Cannot determine service user. Do not run as root directly — use: curl ... | bash (as a normal user)"
fi
info "Services will run as: $HIVE_USER:$HIVE_GROUP"
info "Services will run as: $SPINIFEX_USER:$SPINIFEX_GROUP"
# Allow the service user to manage OVN/OVS and tap devices
$SUDO tee /etc/sudoers.d/hive-network > /dev/null << SUDOERS
# Hive VPC networking: allow service user to manage tap devices, OVS, and OVN
${HIVE_USER} ALL=(root) NOPASSWD: /sbin/ip, /usr/sbin/ip
${HIVE_USER} ALL=(root) NOPASSWD: /usr/bin/ovs-vsctl, /usr/bin/ovs-appctl
${HIVE_USER} ALL=(root) NOPASSWD: /usr/bin/ovn-nbctl, /usr/bin/ovn-sbctl
$SUDO tee /etc/sudoers.d/spinifex-network > /dev/null << SUDOERS
# Spinifex VPC networking: allow service user to manage tap devices, OVS, and OVN
${SPINIFEX_USER} ALL=(root) NOPASSWD: /sbin/ip, /usr/sbin/ip
${SPINIFEX_USER} ALL=(root) NOPASSWD: /usr/bin/ovs-vsctl, /usr/bin/ovs-appctl
${SPINIFEX_USER} ALL=(root) NOPASSWD: /usr/bin/ovn-nbctl, /usr/bin/ovn-sbctl
SUDOERS
$SUDO chmod 0440 /etc/sudoers.d/hive-network
info "Sudoers rules installed for $HIVE_USER"
$SUDO chmod 0440 /etc/sudoers.d/spinifex-network
info "Sudoers rules installed for $SPINIFEX_USER"
}
# --- Install apt dependencies ---
install_apt_deps() {
if [ "${INSTALL_HIVE_SKIP_APT}" = "1" ]; then
info "Skipping apt dependencies (INSTALL_HIVE_SKIP_APT=1)"
if [ "${INSTALL_SPINIFEX_SKIP_APT}" = "1" ]; then
info "Skipping apt dependencies (INSTALL_SPINIFEX_SKIP_APT=1)"
return
fi
@@ -135,8 +135,8 @@ install_apt_deps() {
# --- Install AWS CLI ---
install_aws_cli() {
if [ "${INSTALL_HIVE_SKIP_AWS}" = "1" ]; then
info "Skipping AWS CLI (INSTALL_HIVE_SKIP_AWS=1)"
if [ "${INSTALL_SPINIFEX_SKIP_AWS}" = "1" ]; then
info "Skipping AWS CLI (INSTALL_SPINIFEX_SKIP_AWS=1)"
return
fi
@@ -156,42 +156,42 @@ install_aws_cli() {
}
# --- Download tarball ---
download_hive() {
HIVE_TMPDIR=$(mktemp -d)
TARBALL="$HIVE_TMPDIR/hive.tar.gz"
download_spinifex() {
SPINIFEX_TMPDIR=$(mktemp -d)
TARBALL="$SPINIFEX_TMPDIR/hive.tar.gz"
# Local tarball override — skip download (for testing and air-gapped installs)
if [ -n "$INSTALL_HIVE_TARBALL" ]; then
info "Using local tarball: $INSTALL_HIVE_TARBALL"
cp "$INSTALL_HIVE_TARBALL" "$TARBALL"
if [ -n "$INSTALL_SPINIFEX_TARBALL" ]; then
info "Using local tarball: $INSTALL_SPINIFEX_TARBALL"
cp "$INSTALL_SPINIFEX_TARBALL" "$TARBALL"
info "Extracting..."
tar -xzf "$TARBALL" -C "$HIVE_TMPDIR"
EXTRACT_DIR="$HIVE_TMPDIR"
tar -xzf "$TARBALL" -C "$SPINIFEX_TMPDIR"
EXTRACT_DIR="$SPINIFEX_TMPDIR"
return
fi
if [ -n "$INSTALL_HIVE_VERSION" ]; then
DOWNLOAD_URL="${INSTALL_BASE_URL}/download/${INSTALL_HIVE_VERSION}/${ARCH}"
info "Downloading Hive $INSTALL_HIVE_VERSION ($ARCH)..."
if [ -n "$INSTALL_SPINIFEX_VERSION" ]; then
DOWNLOAD_URL="${INSTALL_BASE_URL}/download/${INSTALL_SPINIFEX_VERSION}/${ARCH}"
info "Downloading Spinifex $INSTALL_SPINIFEX_VERSION ($ARCH)..."
else
DOWNLOAD_URL="${INSTALL_BASE_URL}/download/${INSTALL_HIVE_CHANNEL}/${ARCH}"
info "Downloading Hive ($INSTALL_HIVE_CHANNEL channel, $ARCH)..."
DOWNLOAD_URL="${INSTALL_BASE_URL}/download/${INSTALL_SPINIFEX_CHANNEL}/${ARCH}"
info "Downloading Spinifex ($INSTALL_SPINIFEX_CHANNEL channel, $ARCH)..."
fi
HTTP_CODE=$(curl -fsSL -w '%{http_code}' -o "$TARBALL" "$DOWNLOAD_URL" 2>/dev/null) || true
if [ ! -f "$TARBALL" ] || [ "$HTTP_CODE" -ge 400 ] 2>/dev/null; then
rm -rf "$HIVE_TMPDIR"
fatal "Failed to download Hive from $DOWNLOAD_URL (HTTP $HTTP_CODE)"
rm -rf "$SPINIFEX_TMPDIR"
fatal "Failed to download Spinifex from $DOWNLOAD_URL (HTTP $HTTP_CODE)"
fi
# Verify checksum if available
CHECKSUM_URL="${DOWNLOAD_URL}.sha256"
if curl -fsSL -o "$HIVE_TMPDIR/checksum.sha256" "$CHECKSUM_URL" 2>/dev/null; then
if curl -fsSL -o "$SPINIFEX_TMPDIR/checksum.sha256" "$CHECKSUM_URL" 2>/dev/null; then
info "Verifying checksum..."
EXPECTED=$(awk '{print $1}' "$HIVE_TMPDIR/checksum.sha256")
EXPECTED=$(awk '{print $1}' "$SPINIFEX_TMPDIR/checksum.sha256")
ACTUAL=$(sha256sum "$TARBALL" | awk '{print $1}')
if [ "$EXPECTED" != "$ACTUAL" ]; then
rm -rf "$HIVE_TMPDIR"
rm -rf "$SPINIFEX_TMPDIR"
fatal "Checksum verification failed. Expected: $EXPECTED, Got: $ACTUAL"
fi
info "Checksum verified"
@@ -201,8 +201,8 @@ download_hive() {
# Extract
info "Extracting..."
tar -xzf "$TARBALL" -C "$HIVE_TMPDIR"
EXTRACT_DIR="$HIVE_TMPDIR"
tar -xzf "$TARBALL" -C "$SPINIFEX_TMPDIR"
EXTRACT_DIR="$SPINIFEX_TMPDIR"
}
# --- Place files ---
@@ -210,8 +210,8 @@ install_files() {
info "Installing files..."
# Binary
$SUDO install -m 0755 "$EXTRACT_DIR/hive" /usr/local/bin/hive
info " /usr/local/bin/hive"
$SUDO install -m 0755 "$EXTRACT_DIR/spx" /usr/local/bin/spx
info " /usr/local/bin/spx"
# nbdkit plugin
PLUGINDIR=$(nbdkit --dump-config 2>/dev/null | grep ^plugindir= | cut -d= -f2)
@@ -228,10 +228,10 @@ install_files() {
info " $PLUGINDIR/nbdkit-viperblock-plugin.so"
# Setup scripts
$SUDO mkdir -p /usr/local/share/hive
$SUDO mkdir -p /usr/local/share/spinifex
if [ -f "$EXTRACT_DIR/setup-ovn.sh" ]; then
$SUDO install -m 0755 "$EXTRACT_DIR/setup-ovn.sh" /usr/local/share/hive/setup-ovn.sh
info " /usr/local/share/hive/setup-ovn.sh"
$SUDO install -m 0755 "$EXTRACT_DIR/setup-ovn.sh" /usr/local/share/spinifex/setup-ovn.sh
info " /usr/local/share/spinifex/setup-ovn.sh"
fi
}
@@ -239,39 +239,39 @@ install_files() {
create_directories() {
info "Creating directories..."
$SUDO mkdir -p /etc/hive
$SUDO chmod 0700 /etc/hive
$SUDO chown "$HIVE_USER:$HIVE_GROUP" /etc/hive
$SUDO mkdir -p /etc/spinifex
$SUDO chmod 0700 /etc/spinifex
$SUDO chown "$SPINIFEX_USER:$SPINIFEX_GROUP" /etc/spinifex
$SUDO mkdir -p /var/lib/hive
$SUDO chown "$HIVE_USER:$HIVE_GROUP" /var/lib/hive
$SUDO mkdir -p /var/lib/spinifex
$SUDO chown "$SPINIFEX_USER:$SPINIFEX_GROUP" /var/lib/spinifex
# Symlink so services that expect BaseDir/config/ can find /etc/hive/
if [ ! -e /var/lib/hive/config ]; then
$SUDO ln -s /etc/hive /var/lib/hive/config
# Symlink so services that expect BaseDir/config/ can find /etc/spinifex/
if [ ! -e /var/lib/spinifex/config ]; then
$SUDO ln -s /etc/spinifex /var/lib/spinifex/config
fi
# Symlink so services that write logs to BaseDir/logs/ use /var/log/hive/
if [ ! -e /var/lib/hive/logs ]; then
$SUDO ln -s /var/log/hive /var/lib/hive/logs
# Symlink so services that write logs to BaseDir/logs/ use /var/log/spinifex/
if [ ! -e /var/lib/spinifex/logs ]; then
$SUDO ln -s /var/log/spinifex /var/lib/spinifex/logs
fi
$SUDO mkdir -p /var/log/hive
$SUDO chown "$HIVE_USER:$HIVE_GROUP" /var/log/hive
$SUDO mkdir -p /var/log/spinifex
$SUDO chown "$SPINIFEX_USER:$SPINIFEX_GROUP" /var/log/spinifex
$SUDO mkdir -p /run/hive
$SUDO chown "$HIVE_USER:$HIVE_GROUP" /run/hive
$SUDO mkdir -p /run/spinifex
$SUDO chown "$SPINIFEX_USER:$SPINIFEX_GROUP" /run/spinifex
$SUDO mkdir -p /var/lib/hive/viperblock
$SUDO chown "$HIVE_USER:$HIVE_GROUP" /var/lib/hive/viperblock
$SUDO mkdir -p /var/lib/spinifex/viperblock
$SUDO chown "$SPINIFEX_USER:$SPINIFEX_GROUP" /var/lib/spinifex/viperblock
# Generate environment file with install-specific values (e.g. arch-dependent paths)
$SUDO tee /etc/hive/systemd.env > /dev/null << EOF
$SUDO tee /etc/spinifex/systemd.env > /dev/null << EOF
# Generated by setup.sh — install-specific environment variables
HIVE_VIPERBLOCK_PLUGIN_PATH=${PLUGINDIR}/nbdkit-viperblock-plugin.so
SPINIFEX_VIPERBLOCK_PLUGIN_PATH=${PLUGINDIR}/nbdkit-viperblock-plugin.so
EOF
$SUDO chown "$HIVE_USER:$HIVE_GROUP" /etc/hive/systemd.env
info "Generated /etc/hive/systemd.env"
$SUDO chown "$SPINIFEX_USER:$SPINIFEX_GROUP" /etc/spinifex/systemd.env
info "Generated /etc/spinifex/systemd.env"
}
# --- Install systemd units ---
@@ -284,20 +284,20 @@ install_systemd() {
for unit in "$EXTRACT_DIR"/systemd/*; do
# Substitute User= and Group= with the detected service user
sed "s/^User=hive$/User=$HIVE_USER/;s/^Group=hive$/Group=$HIVE_GROUP/" \
sed "s/^User=hive$/User=$SPINIFEX_USER/;s/^Group=hive$/Group=$SPINIFEX_GROUP/" \
"$unit" | $SUDO tee "/etc/systemd/system/$(basename "$unit")" > /dev/null
$SUDO chmod 0644 "/etc/systemd/system/$(basename "$unit")"
info " /etc/systemd/system/$(basename "$unit")"
done
$SUDO systemctl daemon-reload
info "Systemd units installed (running as $HIVE_USER:$HIVE_GROUP)"
info "Systemd units installed (running as $SPINIFEX_USER:$SPINIFEX_GROUP)"
}
# --- Install logrotate ---
install_logrotate() {
if [ -f "$EXTRACT_DIR/logrotate-hive" ]; then
$SUDO install -m 0644 "$EXTRACT_DIR/logrotate-hive" /etc/logrotate.d/hive
if [ -f "$EXTRACT_DIR/logrotate-spinifex" ]; then
$SUDO install -m 0644 "$EXTRACT_DIR/logrotate-spinifex" /etc/logrotate.d/hive
else
warn "Logrotate config not found in tarball, skipping"
return
@@ -307,61 +307,61 @@ install_logrotate() {
# --- Upgrade handling ---
handle_upgrade() {
if $SUDO systemctl is-active --quiet hive.target 2>/dev/null; then
warn "Hive services are running. Stopping for upgrade..."
$SUDO systemctl stop hive.target
if $SUDO systemctl is-active --quiet spinifex.target 2>/dev/null; then
warn "Spinifex services are running. Stopping for upgrade..."
$SUDO systemctl stop spinifex.target
RESTART_AFTER=true
fi
}
restart_if_needed() {
if [ "${RESTART_AFTER}" = "true" ]; then
info "Restarting Hive services..."
$SUDO systemctl start hive.target
info "Restarting Spinifex services..."
$SUDO systemctl start spinifex.target
fi
}
# --- Print summary ---
print_summary() {
INSTALLED_VERSION=$(/usr/local/bin/hive version 2>/dev/null || echo "unknown")
INSTALLED_VERSION=$(/usr/local/bin/spx version 2>/dev/null || echo "unknown")
echo ""
echo "============================================"
echo " Hive installed successfully"
echo " Spinifex installed successfully"
echo "============================================"
echo ""
echo " Version: $INSTALLED_VERSION"
echo " Architecture: $ARCH"
echo " Service user: $HIVE_USER"
echo " Binary: /usr/local/bin/hive"
echo " Config: /etc/hive/"
echo " Data: /var/lib/hive/"
echo " Logs: /var/log/hive/"
echo " Service user: $SPINIFEX_USER"
echo " Binary: /usr/local/bin/spx"
echo " Config: /etc/spinifex/"
echo " Data: /var/lib/spinifex/"
echo " Logs: /var/log/spinifex/"
echo ""
echo " Next steps:"
echo ""
echo " 1. Setup OVN networking:"
echo " sudo /usr/local/share/hive/setup-ovn.sh --management"
echo " sudo /usr/local/share/spinifex/setup-ovn.sh --management"
echo ""
echo " 2. Initialize a region:"
echo " sudo hive admin init --region <region> --az <az> --node node1 --nodes 1"
echo " sudo spx admin init --region <region> --az <az> --node node1 --nodes 1"
echo ""
echo " 3. Trust the CA certificate:"
echo " sudo cp /etc/hive/ca.pem /usr/local/share/ca-certificates/hive-ca.crt"
echo " sudo cp /etc/spinifex/ca.pem /usr/local/share/ca-certificates/hive-ca.crt"
echo " sudo update-ca-certificates"
echo ""
echo " 4. Start services:"
echo " sudo systemctl start hive.target"
echo " sudo systemctl start spinifex.target"
echo ""
echo " 5. Verify:"
echo " export AWS_PROFILE=hive"
echo " export AWS_PROFILE=spinifex"
echo " aws ec2 describe-instance-types"
echo ""
}
# --- Main ---
main() {
info "Hive installer"
info "Spinifex installer"
echo ""
setup_sudo
@@ -371,12 +371,12 @@ main() {
install_apt_deps
install_aws_cli
detect_service_user
download_hive
download_spinifex
install_files
create_directories
install_systemd
install_logrotate
rm -rf "$HIVE_TMPDIR"
rm -rf "$SPINIFEX_TMPDIR"
restart_if_needed
print_summary
}
scripts/start-dev.sh
+73 -73
View File
@@ -1,13 +1,13 @@
#!/bin/bash
# Start Hive development environment
# This script starts all required services in the correct order using Hive service commands
# Start Spinifex development environment
# This script starts all required services in the correct order using Spinifex service commands
# Usage: ./scripts/start-dev.sh [--build] [data-dir]
# --build: Rebuild all binaries before starting (default: skip build)
# data-dir: Optional data directory path (default: ~/hive)
# data-dir: Optional data directory path (default: ~/spinifex)
#
# Environment variables:
# UI=false Skip starting Hive UI (e.g., UI=false ./scripts/start-dev.sh)
# UI=false Skip starting Spinifex UI (e.g., UI=false ./scripts/start-dev.sh)
set -e
@@ -17,7 +17,7 @@ MULGA_ROOT="$(cd "$PROJECT_ROOT/.." && pwd)"
# Parse arguments
BUILD=false
DATA_DIR="$HOME/hive"
DATA_DIR="$HOME/spinifex"
for arg in "$@"; do
case "$arg" in
--build) BUILD=true ;;
@@ -31,15 +31,15 @@ CONFIG_DIR="${CONFIG_DIR:-$DATA_DIR/config}"
echo "Using data directory: $DATA_DIR"
echo "Using configuration directory: $CONFIG_DIR"
LOGS_DIR="$DATA_DIR/logs"
WAL_DIR="$DATA_DIR/hive"
WAL_DIR="$DATA_DIR/spinifex"
echo "🚀 Starting Hive development environment..."
echo "🚀 Starting Spinifex development environment..."
echo "Project root: $PROJECT_ROOT"
echo "Data directory: $DATA_DIR"
# Parse services from hive.toml — defaults to all if not set
# Parse services from spinifex.toml — defaults to all if not set
parse_services() {
local config_file="$CONFIG_DIR/hive.toml"
local config_file="$CONFIG_DIR/spinifex.toml"
if [ -f "$config_file" ]; then
local svc_line=$(grep -m1 '^services' "$config_file" | sed 's/.*\[//;s/\].*//;s/"//g;s/,/ /g')
if [ -n "$svc_line" ]; then
@@ -59,7 +59,7 @@ echo "Services: $SERVICES"
# Detect multi-node cluster from config
is_multinode() {
local config_file="$CONFIG_DIR/hive.toml"
local config_file="$CONFIG_DIR/spinifex.toml"
if [ -f "$config_file" ]; then
local node_count=$(grep -c '^\[nodes\.' "$config_file")
[ "$node_count" -gt 1 ]
@@ -71,8 +71,8 @@ is_multinode() {
# Confirm configuration directory exists
if [ ! -d "$CONFIG_DIR" ]; then
echo "⚠️ Configuration directory $CONFIG_DIR does not exist."
echo "Please init the hive environment using the CLI."
echo "hive admin init"
echo "Please init the spinifex environment using the CLI."
echo "spx admin init"
exit 1
fi
@@ -177,7 +177,7 @@ check_service() {
if [ "$BUILD" = "true" ]; then
echo "✈️ Pre-flight, compiling latest..."
echo " Building hive..."
echo " Building spinifex..."
make build
echo " Building predastore..."
@@ -231,14 +231,14 @@ if has_service "nats"; then
echo "1️⃣ Starting NATS server..."
if [ -f "$CONFIG_DIR/nats/nats.conf" ]; then
export HIVE_CONFIG_PATH=$CONFIG_DIR/nats/nats.conf
export SPINIFEX_CONFIG_PATH=$CONFIG_DIR/nats/nats.conf
echo " Using NATS config file: $CONFIG_DIR/nats/nats.conf"
else
echo " ⚠️ NATS config file not found at $CONFIG_DIR/nats/nats.conf, using defaults"
export HIVE_NATS_HOST=0.0.0.0
export HIVE_NATS_PORT=4222
export HIVE_NATS_DATA_DIR=$DATA_DIR/nats/
export HIVE_NATS_JETSTREAM=false
export SPINIFEX_NATS_HOST=0.0.0.0
export SPINIFEX_NATS_PORT=4222
export SPINIFEX_NATS_DATA_DIR=$DATA_DIR/nats/
export SPINIFEX_NATS_JETSTREAM=false
fi
# Extract NATS listen address from config (multi-node binds to specific IP, not 127.0.0.1)
@@ -250,14 +250,14 @@ if has_service "nats"; then
fi
fi
NATS_CMD="./bin/hive service nats start"
NATS_CMD="./bin/spx service nats start"
start_service "nats" "$NATS_CMD"
set_oom_score "nats" "-500"
check_service "NATS" "$NATS_CHECK_HOST" "4222"
# Wait for NATS JetStream to be ready before Predastore starts.
# Predastore lazily opens IAM KV buckets — it starts with config-only auth
# and activates IAM auth once the hive daemon creates the KV buckets.
# and activates IAM auth once the spinifex daemon creates the KV buckets.
echo "🔍 Waiting for NATS JetStream..."
NATS_JS_READY=false
for i in $(seq 1 15); do
@@ -280,43 +280,43 @@ fi
echo ""
if has_service "predastore"; then
echo "2️⃣ Starting Predastore..."
unset HIVE_CONFIG_PATH
unset SPINIFEX_CONFIG_PATH
export HIVE_PREDASTORE_BASE_PATH=$DATA_DIR/predastore/
export HIVE_PREDASTORE_CONFIG_PATH=$CONFIG_DIR/predastore/predastore.toml
export HIVE_PREDASTORE_TLS_CERT=$CONFIG_DIR/server.pem
export HIVE_PREDASTORE_TLS_KEY=$CONFIG_DIR/server.key
export SPINIFEX_PREDASTORE_BASE_PATH=$DATA_DIR/predastore/
export SPINIFEX_PREDASTORE_CONFIG_PATH=$CONFIG_DIR/predastore/predastore.toml
export SPINIFEX_PREDASTORE_TLS_CERT=$CONFIG_DIR/server.pem
export SPINIFEX_PREDASTORE_TLS_KEY=$CONFIG_DIR/server.key
# Auto-detect Predastore host:port from hive.toml [nodes.<name>.predastore] section
# Auto-detect Predastore host:port from spinifex.toml [nodes.<name>.predastore] section
PREDASTORE_BIND="0.0.0.0:8443"
if [ -f "$CONFIG_DIR/hive.toml" ]; then
DETECTED_PREDASTORE_HOST=$(awk -F'"' '/\[nodes\..*\.predastore\]/{found=1} found && /^host/{print $2; exit}' "$CONFIG_DIR/hive.toml")
if [ -f "$CONFIG_DIR/spinifex.toml" ]; then
DETECTED_PREDASTORE_HOST=$(awk -F'"' '/\[nodes\..*\.predastore\]/{found=1} found && /^host/{print $2; exit}' "$CONFIG_DIR/spinifex.toml")
if [ -n "$DETECTED_PREDASTORE_HOST" ]; then
PREDASTORE_BIND="$DETECTED_PREDASTORE_HOST"
echo " Auto-detected Predastore bind=$PREDASTORE_BIND from hive.toml"
echo " Auto-detected Predastore bind=$PREDASTORE_BIND from spinifex.toml"
fi
fi
export HIVE_PREDASTORE_HOST="${PREDASTORE_BIND%%:*}"
export HIVE_PREDASTORE_PORT="${PREDASTORE_BIND##*:}"
export SPINIFEX_PREDASTORE_HOST="${PREDASTORE_BIND%%:*}"
export SPINIFEX_PREDASTORE_PORT="${PREDASTORE_BIND##*:}"
export HIVE_PREDASTORE_BACKEND=distributed
export SPINIFEX_PREDASTORE_BACKEND=distributed
# Auto-detect Predastore NODE_ID from hive.toml if not already set
if [ -z "$HIVE_PREDASTORE_NODE_ID" ]; then
if [ -f "$CONFIG_DIR/hive.toml" ]; then
DETECTED_NODE_ID=$(awk -F'= *' '/node_id/{gsub(/ /,"",$2); print $2; exit}' "$CONFIG_DIR/hive.toml")
# Auto-detect Predastore NODE_ID from spinifex.toml if not already set
if [ -z "$SPINIFEX_PREDASTORE_NODE_ID" ]; then
if [ -f "$CONFIG_DIR/spinifex.toml" ]; then
DETECTED_NODE_ID=$(awk -F'= *' '/node_id/{gsub(/ /,"",$2); print $2; exit}' "$CONFIG_DIR/spinifex.toml")
if [ -n "$DETECTED_NODE_ID" ] && [ "$DETECTED_NODE_ID" != "0" ]; then
export HIVE_PREDASTORE_NODE_ID="$DETECTED_NODE_ID"
echo " Auto-detected Predastore NODE_ID=$DETECTED_NODE_ID from hive.toml"
export SPINIFEX_PREDASTORE_NODE_ID="$DETECTED_NODE_ID"
echo " Auto-detected Predastore NODE_ID=$DETECTED_NODE_ID from spinifex.toml"
fi
fi
fi
export HIVE_PREDASTORE_NODE_ID="${HIVE_PREDASTORE_NODE_ID:-}"
export SPINIFEX_PREDASTORE_NODE_ID="${SPINIFEX_PREDASTORE_NODE_ID:-}"
PREDASTORE_CMD="./bin/hive service predastore start"
PREDASTORE_CMD="./bin/spx service predastore start"
start_service "predastore" "$PREDASTORE_CMD"
set_oom_score "predastore" "-500"
check_service "Predastore" "$HIVE_PREDASTORE_HOST" "$HIVE_PREDASTORE_PORT"
check_service "Predastore" "$SPINIFEX_PREDASTORE_HOST" "$SPINIFEX_PREDASTORE_PORT"
else
echo "2️⃣ Skipping Predastore (not a local service)"
fi
@@ -344,31 +344,31 @@ if has_service "viperblock"; then
cd "$PROJECT_ROOT"
fi
export HIVE_CONFIG_PATH=$CONFIG_DIR/hive.toml
export HIVE_VIPERBLOCK_PLUGIN_PATH=$NBD_PLUGIN_PATH
export HIVE_BASE_DIR=$VB_BASE_DIR
export SPINIFEX_CONFIG_PATH=$CONFIG_DIR/spinifex.toml
export SPINIFEX_VIPERBLOCK_PLUGIN_PATH=$NBD_PLUGIN_PATH
export SPINIFEX_BASE_DIR=$VB_BASE_DIR
VIPERBLOCK_CMD="./bin/hive service viperblock start"
VIPERBLOCK_CMD="./bin/spx service viperblock start"
start_service "viperblock" "$VIPERBLOCK_CMD"
set_oom_score "viperblock" "-500"
else
echo "3️⃣ Skipping Viperblock (not a local service)"
fi
# 4️⃣ Start Hive Gateway/Daemon
# 4️⃣ Start Spinifex Gateway/Daemon
echo ""
if has_service "daemon"; then
echo "4️⃣. Starting Hive Gateway..."
echo "4️⃣. Starting Spinifex Gateway..."
export HIVE_CONFIG_PATH=$CONFIG_DIR/hive.toml
export HIVE_BASE_DIR=$DATA_DIR/hive/
export HIVE_WAL_DIR=$WAL_DIR
export SPINIFEX_CONFIG_PATH=$CONFIG_DIR/spinifex.toml
export SPINIFEX_BASE_DIR=$DATA_DIR/spinifex/
export SPINIFEX_WAL_DIR=$WAL_DIR
HIVE_CMD="./bin/hive service hive start"
start_service "hive" "$HIVE_CMD"
set_oom_score "hive" "-500"
SPINIFEX_CMD="./bin/spx service hive start"
start_service "spinifex" "$SPINIFEX_CMD"
set_oom_score "spinifex" "-500"
else
echo "4️⃣. Skipping Hive Gateway (not a local service)"
echo "4️⃣. Skipping Spinifex Gateway (not a local service)"
fi
@@ -377,14 +377,14 @@ echo ""
if has_service "awsgw"; then
echo "5️⃣. Starting AWS Gateway..."
unset HIVE_NATS_HOST
unset HIVE_PREDASTORE_HOST
export HIVE_BASE_DIR=$DATA_DIR
export HIVE_CONFIG_PATH=$CONFIG_DIR/hive.toml
export HIVE_AWSGW_TLS_CERT=$CONFIG_DIR/server.pem
export HIVE_AWSGW_TLS_KEY=$CONFIG_DIR/server.key
unset SPINIFEX_NATS_HOST
unset SPINIFEX_PREDASTORE_HOST
export SPINIFEX_BASE_DIR=$DATA_DIR
export SPINIFEX_CONFIG_PATH=$CONFIG_DIR/spinifex.toml
export SPINIFEX_AWSGW_TLS_CERT=$CONFIG_DIR/server.pem
export SPINIFEX_AWSGW_TLS_KEY=$CONFIG_DIR/server.key
AWSGW_CMD="./bin/hive service awsgw start"
AWSGW_CMD="./bin/spx service awsgw start"
start_service "awsgw" "$AWSGW_CMD"
set_oom_score "awsgw" "-500"
else
@@ -397,33 +397,33 @@ echo ""
if has_service "vpcd"; then
echo "6️⃣. Starting vpcd (VPC daemon)..."
export HIVE_CONFIG_PATH=$CONFIG_DIR/hive.toml
export SPINIFEX_CONFIG_PATH=$CONFIG_DIR/spinifex.toml
VPCD_CMD="./bin/hive service vpcd start"
VPCD_CMD="./bin/spx service vpcd start"
start_service "vpcd" "$VPCD_CMD"
set_oom_score "vpcd" "-500"
else
echo "6️⃣. Skipping vpcd (not a local service)"
fi
# 7️⃣ Start Hive UI (skip with UI=false or if not a local service)
# 7️⃣ Start Spinifex UI (skip with UI=false or if not a local service)
if [ "${UI}" != "false" ] && has_service "ui"; then
echo ""
echo "7️⃣. Starting Hive UI..."
echo "7️⃣. Starting Spinifex UI..."
HIVEUI_CMD="./bin/hive service hive-ui start"
start_service "hive-ui" "$HIVEUI_CMD"
set_oom_score "hive-ui" "-500"
HIVEUI_CMD="./bin/spx service spinifex-ui start"
start_service "spinifex-ui" "$HIVEUI_CMD"
set_oom_score "spinifex-ui" "-500"
else
echo ""
echo "7️⃣. Skipping Hive UI"
echo "7️⃣. Skipping Spinifex UI"
fi
echo ""
echo "🔗 Service endpoints will be:"
if [ "${UI}" != "false" ]; then
echo " - Hive UI: https://localhost:3000"
echo " - Spinifex UI: https://localhost:3000"
fi
echo " - NATS: nats://localhost:4222"
echo " - Predastore: https://localhost:8443"
@@ -433,7 +433,7 @@ echo "📊 Monitor background service logs:"
echo " tail -f $LOGS_DIR/*.log"
echo ""
echo "🧪 Test with AWS CLI (once daemon is running):"
echo " export AWS_PROFILE=hive"
echo " export AWS_PROFILE=spinifex"
echo " aws ec2 describe-instances"
echo ""
@@ -445,7 +445,7 @@ if is_multinode; then
/^\[nodes\./ { node=1; daemon=0 }
node && /^\[.*\.daemon\]/ { daemon=1 }
daemon && /^host/ { gsub(/[" ]/, "", $3); print $3; daemon=0 }
' "$CONFIG_DIR/hive.toml")
' "$CONFIG_DIR/spinifex.toml")
for peer in $peer_hosts; do
attempts=0
@@ -469,4 +469,4 @@ fi
# This will only be reached if air/daemon exits normally
#echo ""
#echo "🛑 Hive development environment stopped"
#echo "🛑 Spinifex development environment stopped"
scripts/start-multi-nats.sh
+1 -1
View File
@@ -1,3 +1,3 @@
#!/bin/sh
HIVE_CONFIG_PATH=~/node1/config/nats/nats.conf ./bin/hive service nats start
SPINIFEX_CONFIG_PATH=~/node1/config/nats/nats.conf ./bin/spx service nats start
scripts/stop-dev.sh
+22 -22
View File
@@ -1,12 +1,12 @@
#!/bin/bash
# Stop Hive development environment
# Stop Spinifex development environment
# This script stops all services started by start-dev.sh
# Usage: ./scripts/stop-dev.sh
# Note: Services are stopped using PID files, so data-dir is not required
# Accept optional data directory argument
DATA_DIR="${1:-$HOME/hive}"
DATA_DIR="${1:-$HOME/spinifex}"
# Always use the logs directory for PID files — start-dev.sh writes shell PIDs
# there, and Go services write PIDs to their own data dirs. This ensures
@@ -20,16 +20,16 @@ LOGS_DIR="$PROJECT_ROOT/data/logs"
# Check if /mnt/ramdisk is mounted
#if mountpoint -q /mnt/ramdisk; then
#echo "🛑 Stopping Hive development environment..."
#echo "🛑 Stopping Spinifex development environment..."
#sudo umount /mnt/ramdisk
#fi
echo "Stopping Hive development environment..."
echo "Stopping Spinifex development environment..."
# Parse services from hive.toml — defaults to all if not set
# Parse services from spinifex.toml — defaults to all if not set
CONFIG_DIR="${CONFIG_DIR:-$DATA_DIR/config}"
parse_services() {
local config_file="$CONFIG_DIR/hive.toml"
local config_file="$CONFIG_DIR/spinifex.toml"
if [ -f "$config_file" ]; then
local svc_line=$(grep -m1 '^services' "$config_file" | sed 's/.*\[//;s/\].*//;s/"//g;s/,/ /g')
if [ -n "$svc_line" ]; then
@@ -44,15 +44,15 @@ SERVICES=$(parse_services)
has_service() {
local svc="$1"
case "$svc" in
hive) svc="daemon" ;;
hive-ui) svc="ui" ;;
spinifex) svc="daemon" ;;
spinifex-ui) svc="ui" ;;
esac
echo "$SERVICES" | grep -qw "$svc"
}
# Detect multi-node cluster from config
is_multinode() {
local config_file="$CONFIG_DIR/hive.toml"
local config_file="$CONFIG_DIR/spinifex.toml"
if [ -f "$config_file" ]; then
# Count only top-level node sections [nodes.X], not subsections [nodes.X.Y]
local node_count=$(grep -cE '^\[nodes\.[^.]+\]' "$config_file")
@@ -65,10 +65,10 @@ is_multinode() {
# For multi-node clusters, delegate to coordinated shutdown via NATS.
# Only when called without arguments (default path). When a data-dir is
# explicitly provided (e.g., E2E per-node cleanup), use per-service stop.
if is_multinode && [ -z "$HIVE_FORCE_LOCAL_STOP" ] && [ -z "$1" ]; then
if is_multinode && [ -z "$SPINIFEX_FORCE_LOCAL_STOP" ] && [ -z "$1" ]; then
echo "Multi-node cluster detected. Using coordinated shutdown..."
echo " (Set HIVE_FORCE_LOCAL_STOP=1 to force per-service stop)"
exec $PROJECT_ROOT/bin/hive admin cluster shutdown
echo " (Set SPINIFEX_FORCE_LOCAL_STOP=1 to force per-service stop)"
exec $PROJECT_ROOT/bin/spx admin cluster shutdown
fi
# Function to stop service by PID file
@@ -84,8 +84,8 @@ stop_service() {
kill -SIGTERM $(cat "$pidpath/$name.pid" 2>/dev/null) 2>/dev/null || rc=$?
sleep 1
else
# Correct graceful shutdown via hive binary, waits for clean exit
$PROJECT_ROOT/bin/hive service $name stop || rc=$?
# Correct graceful shutdown via spx binary, waits for clean exit
$PROJECT_ROOT/bin/spx service $name stop || rc=$?
fi
if [[ $rc -ne 0 ]]; then
@@ -101,11 +101,11 @@ stop_service() {
# Stop services in reverse order
echo "Stopping services..."
echo ""
# Stop Hive UI first (last to start)
has_service "hive-ui" && stop_service "hive-ui" "$PID_DIR"
# Stop Spinifex UI first (last to start)
has_service "spinifex-ui" && stop_service "spinifex-ui" "$PID_DIR"
# Stop Hive daemon/gateway (it will terminate running instances, unmount nbd devices)
has_service "hive" && stop_service "hive" "$PID_DIR"
# Stop Spinifex daemon/gateway (it will terminate running instances, unmount nbd devices)
has_service "spinifex" && stop_service "spinifex" "$PID_DIR"
# Wait for all QEMU instances to exit before stopping infrastructure services.
# The daemon sends system_powerdown to VMs during shutdown, but may be killed
@@ -143,7 +143,7 @@ has_service "predastore" && stop_service "predastore" "$PID_DIR"
# Stop NATS
has_service "nats" && stop_service "nats" "$PID_DIR"
# Stop OVN networking (prevents idle CPU burn when hive isn't running)
# Stop OVN networking (prevents idle CPU burn when spinifex isn't running)
if pidof systemd >/dev/null 2>&1; then
echo "🛑 Stopping OVN networking..."
sudo systemctl stop ovn-controller 2>/dev/null && echo "✅ ovn-controller stopped" || true
@@ -154,10 +154,10 @@ if pidof systemd >/dev/null 2>&1; then
fi
echo ""
echo "✅ Hive development environment stopped"
echo "✅ Spinifex development environment stopped"
# Show any remaining hive-related processes
remaining=$(pgrep -af '(bin/hive|hive-ui|nats-server|predastore|viperblock|vpcd|qemu-system)' | grep -v "stop-dev.sh" || true)
# Show any remaining spinifex-related processes
remaining=$(pgrep -af '(bin/spx|spinifex-ui|nats-server|predastore|viperblock|vpcd|qemu-system)' | grep -v "stop-dev.sh" || true)
if [[ -n "$remaining" ]]; then
echo ""
echo "⚠️ Some related processes may still be running:"
hive/admin/admin.go → spinifex/admin/admin.go
+1 -1
View File
@@ -145,7 +145,7 @@ func GenerateCertificatesIfNeeded(configDir string, force bool, bindIP string) (
// Print instructions for adding CA to system trust store
fmt.Println("\n📋 To trust the Hive CA system-wide (recommended):")
fmt.Printf(" sudo cp %s /usr/local/share/ca-certificates/hive-ca.crt\n", caCertPath)
fmt.Printf(" sudo cp %s /usr/local/share/ca-certificates/spinifex-ca.crt\n", caCertPath)
fmt.Println(" sudo update-ca-certificates")
fmt.Println("\n This allows AWS CLI and other tools to trust Hive services automatically.")
} else {
hive/admin/admin_test.go → spinifex/admin/admin_test.go
View File
hive/awsec2query/parser.go → spinifex/awsec2query/parser.go
View File
hive/awsec2query/parser_test.go → spinifex/awsec2query/parser_test.go
View File
hive/awserrors/awserrors.go → spinifex/awserrors/awserrors.go
View File
hive/awserrors/awserrors_test.go → spinifex/awserrors/awserrors_test.go
View File
hive/config/config.go → spinifex/config/config.go
+2 -2
View File
@@ -12,7 +12,7 @@ import (
type ClusterConfig struct {
Epoch uint64 `mapstructure:"epoch"` // bump when leader commits changes
Node string `mapstructure:"node"` // my node name
Version string `mapstructure:"version"` // hive version
Version string `mapstructure:"version"` // spinifex version
Nodes map[string]Config `mapstructure:"nodes"` // full config for every node
}
@@ -134,7 +134,7 @@ func (c Config) GetServices() []string {
// LoadConfig loads the configuration from file and environment variables
func LoadConfig(configPath string) (*ClusterConfig, error) {
// Set environment variable prefix
viper.SetEnvPrefix("HIVE")
viper.SetEnvPrefix("SPINIFEX")
viper.AutomaticEnv()
// Try to load config file if it exists
hive/config/config_test.go → spinifex/config/config_test.go
+8 -8
View File
@@ -17,7 +17,7 @@ func resetViper(t *testing.T) {
func TestLoadConfig_ValidTOMLFile(t *testing.T) {
resetViper(t)
dir := t.TempDir()
path := filepath.Join(dir, "hive.toml")
path := filepath.Join(dir, "spinifex.toml")
toml := `
version = "1.0"
@@ -66,7 +66,7 @@ region = "us-east-1"
func TestLoadConfig_MultipleNodes(t *testing.T) {
resetViper(t)
dir := t.TempDir()
path := filepath.Join(dir, "hive.toml")
path := filepath.Join(dir, "spinifex.toml")
toml := `
epoch = 2
@@ -100,7 +100,7 @@ func TestLoadConfig_EmptyConfigPath(t *testing.T) {
func TestLoadConfig_NonexistentFile(t *testing.T) {
resetViper(t)
cfg, err := LoadConfig("/tmp/nonexistent-hive-config-test-12345.toml")
cfg, err := LoadConfig("/tmp/nonexistent-spinifex-config-test-12345.toml")
// Not an error - falls through to defaults
require.NoError(t, err)
require.NotNil(t, cfg)
@@ -137,7 +137,7 @@ epoch = 5
func TestLoadConfig_EnvVarOverrideWithFile(t *testing.T) {
resetViper(t)
dir := t.TempDir()
path := filepath.Join(dir, "hive.toml")
path := filepath.Join(dir, "spinifex.toml")
// Viper's AutomaticEnv only works for keys Viper already knows about
// (from a config file or explicit BindEnv). Provide a minimal config
@@ -146,7 +146,7 @@ func TestLoadConfig_EnvVarOverrideWithFile(t *testing.T) {
node = "file-node"
`), 0600))
t.Setenv("HIVE_NODE", "env-node")
t.Setenv("SPINIFEX_NODE", "env-node")
cfg, err := LoadConfig(path)
require.NoError(t, err)
@@ -305,7 +305,7 @@ func TestNodeBaseDir_EmptyBaseDir(t *testing.T) {
func TestLoadConfig_ViperblockShardWAL_Explicit(t *testing.T) {
resetViper(t)
dir := t.TempDir()
path := filepath.Join(dir, "hive.toml")
path := filepath.Join(dir, "spinifex.toml")
toml := `
node = "n1"
@@ -329,7 +329,7 @@ shardwal = false
func TestLoadConfig_ViperblockShardWAL_DefaultNil(t *testing.T) {
resetViper(t)
dir := t.TempDir()
path := filepath.Join(dir, "hive.toml")
path := filepath.Join(dir, "spinifex.toml")
toml := `
node = "n1"
@@ -349,7 +349,7 @@ region = "us-east-1"
func TestLoadConfig_ViperblockShardWAL_True(t *testing.T) {
resetViper(t)
dir := t.TempDir()
path := filepath.Join(dir, "hive.toml")
path := filepath.Join(dir, "spinifex.toml")
toml := `
node = "n1"
hive/daemon/daemon.go → spinifex/daemon/daemon.go
+75 -75
View File
@@ -28,24 +28,24 @@ import (
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/ec2"
"github.com/go-chi/chi/v5"
"github.com/mulgadc/hive/hive/awserrors"
"github.com/mulgadc/hive/hive/config"
handlers_ec2_account "github.com/mulgadc/hive/hive/handlers/ec2/account"
handlers_ec2_eigw "github.com/mulgadc/hive/hive/handlers/ec2/eigw"
handlers_ec2_igw "github.com/mulgadc/hive/hive/handlers/ec2/igw"
handlers_ec2_image "github.com/mulgadc/hive/hive/handlers/ec2/image"
handlers_ec2_instance "github.com/mulgadc/hive/hive/handlers/ec2/instance"
handlers_ec2_key "github.com/mulgadc/hive/hive/handlers/ec2/key"
handlers_ec2_snapshot "github.com/mulgadc/hive/hive/handlers/ec2/snapshot"
handlers_ec2_tags "github.com/mulgadc/hive/hive/handlers/ec2/tags"
handlers_ec2_volume "github.com/mulgadc/hive/hive/handlers/ec2/volume"
handlers_ec2_vpc "github.com/mulgadc/hive/hive/handlers/ec2/vpc"
"github.com/mulgadc/hive/hive/instancetypes"
"github.com/mulgadc/hive/hive/objectstore"
"github.com/mulgadc/hive/hive/qmp"
"github.com/mulgadc/hive/hive/types"
"github.com/mulgadc/hive/hive/utils"
"github.com/mulgadc/hive/hive/vm"
"github.com/mulgadc/spinifex/spinifex/awserrors"
"github.com/mulgadc/spinifex/spinifex/config"
handlers_ec2_account "github.com/mulgadc/spinifex/spinifex/handlers/ec2/account"
handlers_ec2_eigw "github.com/mulgadc/spinifex/spinifex/handlers/ec2/eigw"
handlers_ec2_igw "github.com/mulgadc/spinifex/spinifex/handlers/ec2/igw"
handlers_ec2_image "github.com/mulgadc/spinifex/spinifex/handlers/ec2/image"
handlers_ec2_instance "github.com/mulgadc/spinifex/spinifex/handlers/ec2/instance"
handlers_ec2_key "github.com/mulgadc/spinifex/spinifex/handlers/ec2/key"
handlers_ec2_snapshot "github.com/mulgadc/spinifex/spinifex/handlers/ec2/snapshot"
handlers_ec2_tags "github.com/mulgadc/spinifex/spinifex/handlers/ec2/tags"
handlers_ec2_volume "github.com/mulgadc/spinifex/spinifex/handlers/ec2/volume"
handlers_ec2_vpc "github.com/mulgadc/spinifex/spinifex/handlers/ec2/vpc"
"github.com/mulgadc/spinifex/spinifex/instancetypes"
"github.com/mulgadc/spinifex/spinifex/objectstore"
"github.com/mulgadc/spinifex/spinifex/qmp"
"github.com/mulgadc/spinifex/spinifex/types"
"github.com/mulgadc/spinifex/spinifex/utils"
"github.com/mulgadc/spinifex/spinifex/vm"
"github.com/mulgadc/viperblock/viperblock"
"github.com/nats-io/nats.go"
"github.com/pelletier/go-toml/v2"
@@ -353,67 +353,67 @@ func (d *Daemon) subscribeAll() error {
subs := []natsSub{
// ec2.RunInstances is handled by dynamic per-instance-type subscriptions
// managed by ResourceManager.initSubscriptions()
{"ec2.CreateKeyPair", d.handleEC2CreateKeyPair, "hive-workers"},
{"ec2.DeleteKeyPair", d.handleEC2DeleteKeyPair, "hive-workers"},
{"ec2.DescribeKeyPairs", d.handleEC2DescribeKeyPairs, "hive-workers"},
{"ec2.ImportKeyPair", d.handleEC2ImportKeyPair, "hive-workers"},
{"ec2.DescribeImages", d.handleEC2DescribeImages, "hive-workers"},
{"ec2.CreateKeyPair", d.handleEC2CreateKeyPair, "spinifex-workers"},
{"ec2.DeleteKeyPair", d.handleEC2DeleteKeyPair, "spinifex-workers"},
{"ec2.DescribeKeyPairs", d.handleEC2DescribeKeyPairs, "spinifex-workers"},
{"ec2.ImportKeyPair", d.handleEC2ImportKeyPair, "spinifex-workers"},
{"ec2.DescribeImages", d.handleEC2DescribeImages, "spinifex-workers"},
{"ec2.CreateImage", d.handleEC2CreateImage, ""},
{"ec2.CreateVolume", d.handleEC2CreateVolume, "hive-workers"},
{"ec2.DescribeVolumes", d.handleEC2DescribeVolumes, "hive-workers"},
{"ec2.ModifyVolume", d.handleEC2ModifyVolume, "hive-workers"},
{"ec2.DeleteVolume", d.handleEC2DeleteVolume, "hive-workers"},
{"ec2.DescribeVolumeStatus", d.handleEC2DescribeVolumeStatus, "hive-workers"},
{"ec2.CreateSnapshot", d.handleEC2CreateSnapshot, "hive-workers"},
{"ec2.DescribeSnapshots", d.handleEC2DescribeSnapshots, "hive-workers"},
{"ec2.DeleteSnapshot", d.handleEC2DeleteSnapshot, "hive-workers"},
{"ec2.CopySnapshot", d.handleEC2CopySnapshot, "hive-workers"},
{"ec2.CreateTags", d.handleEC2CreateTags, "hive-workers"},
{"ec2.DeleteTags", d.handleEC2DeleteTags, "hive-workers"},
{"ec2.DescribeTags", d.handleEC2DescribeTags, "hive-workers"},
{"ec2.CreateEgressOnlyInternetGateway", d.handleEC2CreateEgressOnlyInternetGateway, "hive-workers"},
{"ec2.DeleteEgressOnlyInternetGateway", d.handleEC2DeleteEgressOnlyInternetGateway, "hive-workers"},
{"ec2.DescribeEgressOnlyInternetGateways", d.handleEC2DescribeEgressOnlyInternetGateways, "hive-workers"},
{"ec2.CreateInternetGateway", d.handleEC2CreateInternetGateway, "hive-workers"},
{"ec2.DeleteInternetGateway", d.handleEC2DeleteInternetGateway, "hive-workers"},
{"ec2.DescribeInternetGateways", d.handleEC2DescribeInternetGateways, "hive-workers"},
{"ec2.AttachInternetGateway", d.handleEC2AttachInternetGateway, "hive-workers"},
{"ec2.DetachInternetGateway", d.handleEC2DetachInternetGateway, "hive-workers"},
{"ec2.CreateVpc", d.handleEC2CreateVpc, "hive-workers"},
{"ec2.DeleteVpc", d.handleEC2DeleteVpc, "hive-workers"},
{"ec2.DescribeVpcs", d.handleEC2DescribeVpcs, "hive-workers"},
{"ec2.CreateSubnet", d.handleEC2CreateSubnet, "hive-workers"},
{"ec2.DeleteSubnet", d.handleEC2DeleteSubnet, "hive-workers"},
{"ec2.DescribeSubnets", d.handleEC2DescribeSubnets, "hive-workers"},
{"ec2.CreateNetworkInterface", d.handleEC2CreateNetworkInterface, "hive-workers"},
{"ec2.DeleteNetworkInterface", d.handleEC2DeleteNetworkInterface, "hive-workers"},
{"ec2.DescribeNetworkInterfaces", d.handleEC2DescribeNetworkInterfaces, "hive-workers"},
{"ec2.ModifyInstanceAttribute", d.handleEC2ModifyInstanceAttribute, "hive-workers"},
{"ec2.start", d.handleEC2StartStoppedInstance, "hive-workers"},
{"ec2.terminate", d.handleEC2TerminateStoppedInstance, "hive-workers"},
{"ec2.DescribeStoppedInstances", d.handleEC2DescribeStoppedInstances, "hive-workers"},
{"ec2.DescribeTerminatedInstances", d.handleEC2DescribeTerminatedInstances, "hive-workers"},
{"ec2.CreateVolume", d.handleEC2CreateVolume, "spinifex-workers"},
{"ec2.DescribeVolumes", d.handleEC2DescribeVolumes, "spinifex-workers"},
{"ec2.ModifyVolume", d.handleEC2ModifyVolume, "spinifex-workers"},
{"ec2.DeleteVolume", d.handleEC2DeleteVolume, "spinifex-workers"},
{"ec2.DescribeVolumeStatus", d.handleEC2DescribeVolumeStatus, "spinifex-workers"},
{"ec2.CreateSnapshot", d.handleEC2CreateSnapshot, "spinifex-workers"},
{"ec2.DescribeSnapshots", d.handleEC2DescribeSnapshots, "spinifex-workers"},
{"ec2.DeleteSnapshot", d.handleEC2DeleteSnapshot, "spinifex-workers"},
{"ec2.CopySnapshot", d.handleEC2CopySnapshot, "spinifex-workers"},
{"ec2.CreateTags", d.handleEC2CreateTags, "spinifex-workers"},
{"ec2.DeleteTags", d.handleEC2DeleteTags, "spinifex-workers"},
{"ec2.DescribeTags", d.handleEC2DescribeTags, "spinifex-workers"},
{"ec2.CreateEgressOnlyInternetGateway", d.handleEC2CreateEgressOnlyInternetGateway, "spinifex-workers"},
{"ec2.DeleteEgressOnlyInternetGateway", d.handleEC2DeleteEgressOnlyInternetGateway, "spinifex-workers"},
{"ec2.DescribeEgressOnlyInternetGateways", d.handleEC2DescribeEgressOnlyInternetGateways, "spinifex-workers"},
{"ec2.CreateInternetGateway", d.handleEC2CreateInternetGateway, "spinifex-workers"},
{"ec2.DeleteInternetGateway", d.handleEC2DeleteInternetGateway, "spinifex-workers"},
{"ec2.DescribeInternetGateways", d.handleEC2DescribeInternetGateways, "spinifex-workers"},
{"ec2.AttachInternetGateway", d.handleEC2AttachInternetGateway, "spinifex-workers"},
{"ec2.DetachInternetGateway", d.handleEC2DetachInternetGateway, "spinifex-workers"},
{"ec2.CreateVpc", d.handleEC2CreateVpc, "spinifex-workers"},
{"ec2.DeleteVpc", d.handleEC2DeleteVpc, "spinifex-workers"},
{"ec2.DescribeVpcs", d.handleEC2DescribeVpcs, "spinifex-workers"},
{"ec2.CreateSubnet", d.handleEC2CreateSubnet, "spinifex-workers"},
{"ec2.DeleteSubnet", d.handleEC2DeleteSubnet, "spinifex-workers"},
{"ec2.DescribeSubnets", d.handleEC2DescribeSubnets, "spinifex-workers"},
{"ec2.CreateNetworkInterface", d.handleEC2CreateNetworkInterface, "spinifex-workers"},
{"ec2.DeleteNetworkInterface", d.handleEC2DeleteNetworkInterface, "spinifex-workers"},
{"ec2.DescribeNetworkInterfaces", d.handleEC2DescribeNetworkInterfaces, "spinifex-workers"},
{"ec2.ModifyInstanceAttribute", d.handleEC2ModifyInstanceAttribute, "spinifex-workers"},
{"ec2.start", d.handleEC2StartStoppedInstance, "spinifex-workers"},
{"ec2.terminate", d.handleEC2TerminateStoppedInstance, "spinifex-workers"},
{"ec2.DescribeStoppedInstances", d.handleEC2DescribeStoppedInstances, "spinifex-workers"},
{"ec2.DescribeTerminatedInstances", d.handleEC2DescribeTerminatedInstances, "spinifex-workers"},
// these 2 fan out to all nodes and gateway aggregates the results
{"ec2.DescribeInstances", d.handleEC2DescribeInstances, ""},
{"ec2.DescribeInstanceTypes", d.handleEC2DescribeInstanceTypes, ""},
{"ec2.EnableEbsEncryptionByDefault", d.handleEC2EnableEbsEncryptionByDefault, "hive-workers"},
{"ec2.DisableEbsEncryptionByDefault", d.handleEC2DisableEbsEncryptionByDefault, "hive-workers"},
{"ec2.GetEbsEncryptionByDefault", d.handleEC2GetEbsEncryptionByDefault, "hive-workers"},
{"ec2.GetSerialConsoleAccessStatus", d.handleEC2GetSerialConsoleAccessStatus, "hive-workers"},
{"ec2.EnableSerialConsoleAccess", d.handleEC2EnableSerialConsoleAccess, "hive-workers"},
{"ec2.DisableSerialConsoleAccess", d.handleEC2DisableSerialConsoleAccess, "hive-workers"},
{fmt.Sprintf("hive.admin.%s.health", d.node), d.handleHealthCheck, ""},
{"hive.nodes.discover", d.handleNodeDiscover, ""},
{"hive.node.status", d.handleNodeStatus, ""},
{"hive.node.vms", d.handleNodeVMs, ""},
{"ec2.EnableEbsEncryptionByDefault", d.handleEC2EnableEbsEncryptionByDefault, "spinifex-workers"},
{"ec2.DisableEbsEncryptionByDefault", d.handleEC2DisableEbsEncryptionByDefault, "spinifex-workers"},
{"ec2.GetEbsEncryptionByDefault", d.handleEC2GetEbsEncryptionByDefault, "spinifex-workers"},
{"ec2.GetSerialConsoleAccessStatus", d.handleEC2GetSerialConsoleAccessStatus, "spinifex-workers"},
{"ec2.EnableSerialConsoleAccess", d.handleEC2EnableSerialConsoleAccess, "spinifex-workers"},
{"ec2.DisableSerialConsoleAccess", d.handleEC2DisableSerialConsoleAccess, "spinifex-workers"},
{fmt.Sprintf("spinifex.admin.%s.health", d.node), d.handleHealthCheck, ""},
{"spinifex.nodes.discover", d.handleNodeDiscover, ""},
{"spinifex.node.status", d.handleNodeStatus, ""},
{"spinifex.node.vms", d.handleNodeVMs, ""},
// Account creation → create default VPC for new account
{"iam.account.created", d.handleAccountCreated, "hive-workers"},
{"iam.account.created", d.handleAccountCreated, "spinifex-workers"},
// Coordinated cluster shutdown phases (fan-out, no queue group)
{"hive.cluster.shutdown.gate", d.handleShutdownGate, ""},
{"hive.cluster.shutdown.drain", d.handleShutdownDrain, ""},
{"hive.cluster.shutdown.storage", d.handleShutdownStorage, ""},
{"hive.cluster.shutdown.persist", d.handleShutdownPersist, ""},
{"hive.cluster.shutdown.infra", d.handleShutdownInfra, ""},
{"spinifex.cluster.shutdown.gate", d.handleShutdownGate, ""},
{"spinifex.cluster.shutdown.drain", d.handleShutdownDrain, ""},
{"spinifex.cluster.shutdown.storage", d.handleShutdownStorage, ""},
{"spinifex.cluster.shutdown.persist", d.handleShutdownPersist, ""},
{"spinifex.cluster.shutdown.infra", d.handleShutdownInfra, ""},
}
for _, s := range subs {
@@ -2357,7 +2357,7 @@ func (rm *ResourceManager) initSubscriptions(nc *nats.Conn, handler nats.MsgHand
// updateInstanceSubscriptions recalculates which instance types can fit on this
// node and subscribes/unsubscribes from the corresponding NATS topics. Each type
// gets its own topic (ec2.RunInstances.{type}) with the hive-workers queue group,
// gets its own topic (ec2.RunInstances.{type}) with the spinifex-workers queue group,
// so NATS only routes requests to nodes that can actually serve them.
func (rm *ResourceManager) updateInstanceSubscriptions() {
if rm.natsConn == nil {
@@ -2373,7 +2373,7 @@ func (rm *ResourceManager) updateInstanceSubscriptions() {
_, subscribed := rm.instanceSubs[topic]
if canFit && !subscribed {
sub, err := rm.natsConn.QueueSubscribe(topic, "hive-workers", rm.handler)
sub, err := rm.natsConn.QueueSubscribe(topic, "spinifex-workers", rm.handler)
if err != nil {
slog.Error("Failed to subscribe to instance type topic", "topic", topic, "err", err)
continue
hive/daemon/daemon_handlers.go → spinifex/daemon/daemon_handlers.go
+4 -4
View File
@@ -7,10 +7,10 @@ import (
"net"
"time"
"github.com/mulgadc/hive/hive/awserrors"
"github.com/mulgadc/hive/hive/types"
"github.com/mulgadc/hive/hive/utils"
"github.com/mulgadc/hive/hive/vm"
"github.com/mulgadc/spinifex/spinifex/awserrors"
"github.com/mulgadc/spinifex/spinifex/types"
"github.com/mulgadc/spinifex/spinifex/utils"
"github.com/mulgadc/spinifex/spinifex/vm"
"github.com/nats-io/nats.go"
)
hive/daemon/daemon_handlers_account.go → spinifex/daemon/daemon_handlers_account.go
View File
hive/daemon/daemon_handlers_console.go → spinifex/daemon/daemon_handlers_console.go
+2 -2
View File
@@ -7,8 +7,8 @@ import (
"time"
"github.com/aws/aws-sdk-go/service/ec2"
"github.com/mulgadc/hive/hive/awserrors"
"github.com/mulgadc/hive/hive/utils"
"github.com/mulgadc/spinifex/spinifex/awserrors"
"github.com/mulgadc/spinifex/spinifex/utils"
"github.com/nats-io/nats.go"
)
hive/daemon/daemon_handlers_igw.go → spinifex/daemon/daemon_handlers_igw.go
View File
hive/daemon/daemon_handlers_image.go → spinifex/daemon/daemon_handlers_image.go
+4 -4
View File
@@ -4,10 +4,10 @@ import (
"log/slog"
"github.com/aws/aws-sdk-go/service/ec2"
"github.com/mulgadc/hive/hive/awserrors"
handlers_ec2_image "github.com/mulgadc/hive/hive/handlers/ec2/image"
"github.com/mulgadc/hive/hive/utils"
"github.com/mulgadc/hive/hive/vm"
"github.com/mulgadc/spinifex/spinifex/awserrors"
handlers_ec2_image "github.com/mulgadc/spinifex/spinifex/handlers/ec2/image"
"github.com/mulgadc/spinifex/spinifex/utils"
"github.com/mulgadc/spinifex/spinifex/vm"
"github.com/nats-io/nats.go"
)

Some files were not shown because too many files have changed in this diff Show More