diff --git a/README.md b/README.md index 73e811af4..9ac8ceab8 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ What is Spinifex? · Platform · Deploy · - AWS services · + AWS Compatibility · Components · Architecture · Installation · @@ -48,7 +48,7 @@ You change *where* your software runs, not *what* it is. From commodity hardware up to unmodified AWS tooling, every layer is replaceable and yours to own. -## Three ways to deploy +## Three Ways To Deploy One AWS-compatible surface, three deployment shapes. Pick the one that matches your reality; the platform on top is the same. @@ -71,14 +71,14 @@ Speak the AWS API surface, natively. The AWS SDKs, AWS CLI, and Terraform: every | Service | What it is | Status | | --- | --- | --- | | **EC2** | Compute | Available | -| **EBS** | Block storage | Available | -| **S3** | Object storage | Available | +| **EBS** | Block Storage | Available | +| **S3** | Object Storage | Available | | **VPC** | Networking | Available | -| **IAM** | Identity & auth | Available | -| **ALB / NLB** | Load balancers | Available | +| **IAM** | Identity & Auth | Available | +| **ALB / NLB** | Load Balancers | Available | | **EKS** | Kubernetes | Available | -| **ECR** | Container registry | Available | -| **ECS** | Container service | Available | +| **ECR** | Container Registry | Available | +| **ECS** | Container Service | Available | | **RDS** | Databases | Available | | **Bedrock** | AI Deployment | Q3 2026 | @@ -112,6 +112,14 @@ Spinifex is a minimal VM orchestration layer built on top of QEMU, exposing APIs - Multipart uploads, streaming reads/writes - Data redundancy with Reed-Solomon encoding +### Northstar (Authoritative DNS) + +[Northstar](https://github.com/mulgadc/northstar) is a lightweight authoritative DNS server that handles both internal service discovery and public-facing DNS for a Spinifex cluster. Zones are human-readable TOML files, served from the local filesystem or synced from Predastore, keeping DNS configuration in the same object storage as the rest of your infrastructure. + +- Authoritative DNS over UDP, TCP, and DNS-over-TLS +- Service discovery for cluster components via SRV records +- Zone files stored locally or in S3-compatible storage + ## Architecture at a Glance

@@ -131,7 +139,7 @@ Every AWS API call is authenticated at the gateway, published to a NATS subject, ## Installation -Installation requires an Ubuntu / Debian system. See the detailed documentation at [docs.mulgadc.com](https://docs.mulgadc.com) for maintaining and installing Spinifex. +Installation requires an Ubuntu 26.04 or Debian 13 system. See the detailed documentation at [docs.mulgadc.com](https://docs.mulgadc.com) for installing Spinifex. ### Bare Metal ISO @@ -145,8 +153,6 @@ Follow the [USB install guide](https://docs.mulgadc.com/docs/install-usb) to wri ### Single Node Install -The installation is straightforward to set up and running on a single node for testing purposes. Debian 13 is currently supported, additional Linux distributions are on the immediate roadmap. - >*Prerequisite:* Spinifex requires a Linux bridge configured on the host for VM networking. See the [single-node install guide](https://docs.mulgadc.com/docs/install#prerequisites) for setup details. ```bash @@ -171,8 +177,9 @@ For a complete development environment see the [Source Install](https://docs.mul 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 +- **[Predastore](https://github.com/mulgadc/predastore)** - S3 compatible object storage +- **[Viperblock](https://github.com/mulgadc/viperblock)** - EBS compatible block storage +- **[Northstar](https://github/mulgadc/northstar)** - Authoritative DNS server Each component can be developed independently. See component-specific documentation for focused development guides.