Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ dist/

# nexus-ami staging artifacts populated by nexus-ami/build.sh — the binaries,
# UI dist, and Prisma bundle are derived from the source tree on every build
# and should never be committed. Architecture:
# docs/developers/architecture/cross-cutting/deployment/ami-appliance-architecture.md
# and should never be committed. See nexus-ami/README.md for the build flow.
nexus-ami/artifacts/bin/
nexus-ami/artifacts/ui-dist/
nexus-ami/artifacts/prisma/
Expand Down
5 changes: 2 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -134,10 +134,9 @@ agent-package-windows: agent-build-windows
agent-clean-windows:
rm -rf dist/windows

# ── AMI / appliance build (E-OSS marketplace) ────────────────────────
# ── AMI / appliance build ────────────────────────────────────────────
# Wraps Go binaries + UI dist + Prisma bundle + Packer build into one
# invocation. Architecture:
# docs/developers/architecture/cross-cutting/deployment/ami-appliance-architecture.md
# invocation. See nexus-ami/README.md for the build / publish runbook.

ami-build:
bash nexus-ami/build.sh
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Nexus Gateway

[![CI](https://github.com/your-org/abc-nexus-gateway/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/your-org/abc-nexus-gateway/actions/workflows/ci.yml)
[![Go CI](https://github.com/your-org/abc-nexus-gateway/actions/workflows/go-ci.yml/badge.svg?branch=main)](https://github.com/your-org/abc-nexus-gateway/actions/workflows/go-ci.yml)
[![CI](https://github.com/AlphaBitCore/nexus-gateway/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/AlphaBitCore/nexus-gateway/actions/workflows/ci.yml)
[![Go CI](https://github.com/AlphaBitCore/nexus-gateway/actions/workflows/go-ci.yml/badge.svg?branch=main)](https://github.com/AlphaBitCore/nexus-gateway/actions/workflows/go-ci.yml)
[![Coverage gate](https://img.shields.io/badge/coverage-%E2%89%A595%25%20per%20package-brightgreen)](./scripts/check-go-coverage.sh)
[![Status: Pre-GA](https://img.shields.io/badge/status-Pre--GA%20%C2%B7%20active%20development-orange)](./CHANGELOG.md)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
Expand Down Expand Up @@ -119,10 +119,8 @@ The lateral dotted arrow is the **attestation handoff**: the Agent always egress

| Form factor | How | Status |
|---|---|---|
| **AWS Marketplace AMI / single-instance appliance** | `cd nexus-ami && ./build.sh` — bakes binaries + UI + Prisma + nginx + Postgres + Valkey + NATS into one AL2023 image via Packer | [`nexus-ami/README.md`](./nexus-ami/README.md) for build steps, [`docs/developers/architecture/cross-cutting/deployment/ami-appliance-architecture.md`](./docs/developers/architecture/cross-cutting/deployment/ami-appliance-architecture.md) for design |
| **Local development** | docker-compose + `./scripts/dev-start.sh` (Postgres + Valkey + NATS) and per-service `go run ./cmd/<svc>/` | See **Quick start** below |
| **VMware / KVM image / bare-metal appliance** | Reuses the same `install.sh` + `harden.sh` from `nexus-ami/scripts/` under a different Packer builder | Future |
| **Container / Kubernetes** | Out of scope for the appliance form factor — separate product line | Future |
| **Container / Kubernetes** | Container images per service — separate product line | Future |

---

Expand Down
6 changes: 0 additions & 6 deletions docs/developers/architecture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,12 +168,6 @@ If you are about to edit code in an area that is genuinely **not** covered by an
| i18n keys (`t('namespace:section.key')`), locale files (`packages/*/src/i18n/locales/**`), `packages/ui-shared/src/i18n/**` | `docs/developers/architecture/cross-cutting/ui/ui-i18n-architecture.md` |
| `useApi` / `useApiMutation` hooks + queryKey shape, `shellRouteConfig.tsx` / `Sidebar.tsx` IA, `packages/ui-shared/**` cross-bundle components | `docs/developers/architecture/cross-cutting/ui/ui-shell-architecture.md` |

## Cross-cutting — deployment

| Editing area / file glob | Read FIRST |
|---|---|
| `nexus-ami/**` — Packer template, install / first-boot / harden scripts, prod-shape `*.config.yaml`, systemd unit files for the AMI / bare-metal appliance form factor | `docs/developers/architecture/cross-cutting/deployment/ami-appliance-architecture.md` |

## Adding a new arch doc

When you ship a new `docs/developers/architecture/**/*-architecture.md`:
Expand Down

This file was deleted.

1 change: 0 additions & 1 deletion docs/operators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Documentation for running Nexus Gateway in production.

- [`ops/`](./ops/) — deployment and operations guides:
- [`deployment.md`](./ops/deployment.md) — bring-up and topologies.
- [`ami-build.md`](./ops/ami-build.md) — build the single-instance appliance AMI (AWS Marketplace).
- [`ec2-single-node.md`](./ops/ec2-single-node.md) — a single-node deployment.
- [`install-test-env.md`](./ops/install-test-env.md) — a single-host test or staging install.
- [`backup-dr.md`](./ops/backup-dr.md) — backup and disaster recovery.
Expand Down
Loading
Loading