Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
84403aec0c |
@@ -0,0 +1,25 @@
|
|||||||
|
ARG GO_BASE
|
||||||
|
ARG ALPINE_BASE
|
||||||
|
# build-agent's image: the build machine itself, compiled into a container (novox/hq ADR 0190).
|
||||||
|
#
|
||||||
|
# **The source is not vendored here.** builder's actual code — cmd/mesh-builder, internal/builder,
|
||||||
|
# internal/catalogue — lives in the mesh-controller repository, the same control plane it is one
|
||||||
|
# half of. This module ships the packaging, not a second copy of the source, so the build context
|
||||||
|
# is the mesh-controller repository root (declared under build.artifacts[].context), and this
|
||||||
|
# Dockerfile compiles ./cmd/mesh-builder from it — the same shape route-proxy already uses for the
|
||||||
|
# same reason.
|
||||||
|
FROM ${GO_BASE} AS build
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
RUN CGO_ENABLED=0 GOOS=linux go build -trimpath -o /mesh-builder ./cmd/mesh-builder
|
||||||
|
|
||||||
|
# Unlike mesh-controller's own FROM scratch (ADR 0006: nothing to audit but one binary), the build
|
||||||
|
# machine's whole job is shelling out to git and docker — it needs a real userland to do that in,
|
||||||
|
# not a second copy of either tool vendored into this image. apk installs both from the base's own
|
||||||
|
# packages, not fetched on its own at build time.
|
||||||
|
FROM ${ALPINE_BASE}
|
||||||
|
RUN apk add --no-cache docker-cli git
|
||||||
|
COPY --from=build /mesh-builder /usr/local/bin/mesh-builder
|
||||||
|
ENTRYPOINT ["/usr/local/bin/mesh-builder"]
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
# build-agent
|
||||||
|
|
||||||
|
The mesh's build machine as a role every machine can hold (novox/hq ADR 0190). It holds the node seat
|
||||||
|
`node-build-agent`: every holder pulls one build at a time from the role's one work queue when it is
|
||||||
|
idle, so a tier of many images is built by as many machines as hold the seat and are online, and a
|
||||||
|
machine that is off builds nothing and blocks nothing. The controller asks the role, never a machine;
|
||||||
|
the outcome names the machine that built it.
|
||||||
|
|
||||||
|
What a holding machine needs is what the builder always needed, said here once: a container runtime
|
||||||
|
(the socket is mounted), the artifact store and the package registry as provisions, a workspace, and
|
||||||
|
the bus credential. The code is `cmd/mesh-builder` in the mesh-controller repository, compiled from
|
||||||
|
that repository's main (`build.artifacts[].context`); this module ships the packaging.
|
||||||
|
|
||||||
|
Assign it to every machine with a container runtime. It replaces `builder`, the one-holder form of the
|
||||||
|
same thing; retire that once this is assigned where it was.
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
{
|
||||||
|
"module": "build-agent",
|
||||||
|
"version": "1",
|
||||||
|
"capabilities": [
|
||||||
|
"container-runtime"
|
||||||
|
],
|
||||||
|
"claims": [
|
||||||
|
{
|
||||||
|
"name": "node-build-agent",
|
||||||
|
"scope": "node"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"requires": [
|
||||||
|
"artifact-store",
|
||||||
|
"npm-package-registry"
|
||||||
|
],
|
||||||
|
"binds": {
|
||||||
|
"npm-package-registry": "${dir:mesh-state}/package-registry.json"
|
||||||
|
},
|
||||||
|
"secrets": {
|
||||||
|
"npm-package-registry": "${dir:mesh-state}/package-registry.secret"
|
||||||
|
},
|
||||||
|
"own-secrets": {
|
||||||
|
"broker": "${dir:mesh-state}/broker"
|
||||||
|
},
|
||||||
|
"resources": [
|
||||||
|
{
|
||||||
|
"id": "mesh-state",
|
||||||
|
"type": "directory",
|
||||||
|
"mode": "0700",
|
||||||
|
"place": "mesh"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "workspace",
|
||||||
|
"type": "directory",
|
||||||
|
"mode": "0700"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "agent-env",
|
||||||
|
"type": "file",
|
||||||
|
"path": "${dir:mesh-state}/build-agent.env",
|
||||||
|
"mode": "0600",
|
||||||
|
"content": "MESH_BROKER_FILE=/run/mesh/broker\nMESH_NODE=${machine:name}\nMESH_REGISTRY=${bound:artifact-store:at}:${bound:artifact-store:port}\nMESH_PACKAGE_BINDING=/run/mesh/package-registry.json\nMESH_NPM_TOKEN_FILE=/run/mesh/package-registry.secret\nMESH_WORKSPACE=${dir:workspace}\n"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "server",
|
||||||
|
"type": "container",
|
||||||
|
"name": "mesh-build-agent",
|
||||||
|
"artifact": "server",
|
||||||
|
"env-file": [
|
||||||
|
"${dir:mesh-state}/build-agent.env"
|
||||||
|
],
|
||||||
|
"volumes": [
|
||||||
|
"${dir:mesh-state}:/run/mesh:ro",
|
||||||
|
"${dir:workspace}:${dir:workspace}",
|
||||||
|
"/var/run/docker.sock:/var/run/docker.sock"
|
||||||
|
],
|
||||||
|
"restart-on": [
|
||||||
|
"agent-env"
|
||||||
|
],
|
||||||
|
"network": "host"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"build": {
|
||||||
|
"artifacts": [
|
||||||
|
{
|
||||||
|
"name": "server",
|
||||||
|
"kind": "image",
|
||||||
|
"from": "Dockerfile",
|
||||||
|
"context": {
|
||||||
|
"seat": "git",
|
||||||
|
"repository": "novox/mesh-controller",
|
||||||
|
"ref": "main"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"on": [
|
||||||
|
{
|
||||||
|
"arg": "GO_BASE",
|
||||||
|
"image": "golang@sha256:8ac98ca534ac3f51e1f420a1dd2c15e74c75cfa0f23f3ad27eb5d7236c349a0c"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"arg": "ALPINE_BASE",
|
||||||
|
"image": "alpine@sha256:d9e853e87e55526f6b2917df91a2115c36dd7c696a35be12163d44e6e2a4b6bc"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -242,7 +242,7 @@
|
|||||||
"jails": [
|
"jails": [
|
||||||
{
|
{
|
||||||
"name": "gitea",
|
"name": "gitea",
|
||||||
"failregex": "^.*Failed authentication attempt for .* from <HOST>(?::\\d+)?\\s*$\n ^.*Invalid user .* from <HOST> port \\d+\\s*$\n ^.*User \\S+ from <HOST> not allowed because .*$",
|
"failregex": "^.*Failed authentication attempt for .* from <HOST>(?::\\d+)?\\s*$",
|
||||||
"jail": "backend = systemd\njournalmatch = CONTAINER_NAME=gitea\nport = http,https,222\nmaxretry = 3\nfindtime = 1d\nbantime = 1d"
|
"jail": "backend = systemd\njournalmatch = CONTAINER_NAME=gitea\nport = http,https,222\nmaxretry = 3\nfindtime = 1d\nbantime = 1d"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -0,0 +1,30 @@
|
|||||||
|
# portainer's runtime: the tool runtime, carrying this module's compiled code.
|
||||||
|
#
|
||||||
|
# **Built from this module's own directory and nothing else.** The sdk and the tool runtime are in
|
||||||
|
# the base images, published like any other artifact — which is what makes this buildable by the
|
||||||
|
# mesh from a repository and a path (novox/hq ADR 0069) rather than only on a workstation that
|
||||||
|
# happens to have the siblings.
|
||||||
|
#
|
||||||
|
# Two bases, named rather than pinned (novox/hq issue 044): the image this is COMPILED in and the
|
||||||
|
# image it RUNS in — the second must not carry a compiler. Declared in module.json's `build.on`.
|
||||||
|
ARG BUILD_BASE
|
||||||
|
ARG RUNTIME_BASE
|
||||||
|
|
||||||
|
FROM ${BUILD_BASE} AS build
|
||||||
|
# Compiled under /app/modules so `@novox/mesh-sdk` resolves upward into the base's own
|
||||||
|
# node_modules — the module is compiled against exactly the sdk it will run against. The compiler
|
||||||
|
# is invoked by its real path: node_modules/.bin entries are launcher symlinks the base image
|
||||||
|
# resolved away.
|
||||||
|
WORKDIR /app/modules/portainer
|
||||||
|
COPY . .
|
||||||
|
RUN node /app/node_modules/typescript/bin/tsc client.ts tools/index.ts \
|
||||||
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
|
FROM ${RUNTIME_BASE}
|
||||||
|
COPY --from=build /app/modules/portainer/dist /app/modules/portainer/dist
|
||||||
|
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
||||||
|
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||||
|
# the convention novox/hq issues 060/061 settled. A container that instead ran only its
|
||||||
|
# provisioner (`run`) served no tools and emitted no events; a container that named no command
|
||||||
|
# ran no provisioner at all.
|
||||||
|
ENV MESH_TOOL_MODULES=/app/modules/portainer/dist/tools/index.js
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
// The Portainer API client — portainer's own code, living in the module (novox/hq ADR 0039).
|
||||||
|
// portainer is tools-only: its "events" would really be the underlying containers' lifecycle,
|
||||||
|
// which the host owns and emits — so this module reads Portainer's own resources (endpoints,
|
||||||
|
// stacks, containers) and exposes them, and stops there.
|
||||||
|
|
||||||
|
import { readFileSync } from "node:fs";
|
||||||
|
|
||||||
|
export interface PortainerEndpoint {
|
||||||
|
id: number;
|
||||||
|
name: string;
|
||||||
|
type: number;
|
||||||
|
url: string;
|
||||||
|
status: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PortainerStack {
|
||||||
|
id: number;
|
||||||
|
name: string;
|
||||||
|
type: number;
|
||||||
|
endpointId: number;
|
||||||
|
status: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PortainerContainer {
|
||||||
|
id: string;
|
||||||
|
names: string[];
|
||||||
|
image: string;
|
||||||
|
state: string;
|
||||||
|
status: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The settings-merged config the mesh delivers (novox/hq ADR 0046): { url, apiKey, token, password, user, ... }. */
|
||||||
|
function meshConfig(file?: string): Record<string, string> {
|
||||||
|
if (!file) return {};
|
||||||
|
try { return JSON.parse(readFileSync(file, "utf8")) as Record<string, string>; }
|
||||||
|
catch { return {}; }
|
||||||
|
}
|
||||||
|
|
||||||
|
export class PortainerClient {
|
||||||
|
readonly baseUrl: string;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
url: string,
|
||||||
|
private readonly token: string,
|
||||||
|
) {
|
||||||
|
this.baseUrl = url.replace(/\/+$/, "");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build from the module's resolved environment. The URL is MESH_PORTAINER_URL (or the local
|
||||||
|
* dashboard port) and the API token is MESH_PORTAINER_TOKEN — an access token minted in
|
||||||
|
* Portainer, sent as X-API-Key. Throws when no token is configured, so a misconfigured module
|
||||||
|
* exposes nothing rather than calling Portainer unauthenticated.
|
||||||
|
*/
|
||||||
|
static fromEnv(env: NodeJS.ProcessEnv = process.env): PortainerClient {
|
||||||
|
const cfg = meshConfig(env.MESH_PORTAINER_CONFIG_FILE);
|
||||||
|
const url = cfg.url ?? env.MESH_PORTAINER_URL ?? `https://127.0.0.1:${env.PORTAINER_PORT ?? "9443"}`;
|
||||||
|
const token = cfg.token ?? env.MESH_PORTAINER_TOKEN;
|
||||||
|
if (!token) throw new Error("no Portainer token — set MESH_PORTAINER_TOKEN");
|
||||||
|
return new PortainerClient(url, token);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async get<T>(path: string): Promise<T> {
|
||||||
|
const res = await fetch(`${this.baseUrl}${path}`, { headers: { "X-API-Key": this.token } });
|
||||||
|
if (!res.ok) throw new Error(`Portainer ${path}: ${res.status} ${await res.text()}`);
|
||||||
|
return res.json() as Promise<T>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The environments (endpoints) Portainer manages — each a Docker host or cluster it talks to. */
|
||||||
|
async listEndpoints(): Promise<PortainerEndpoint[]> {
|
||||||
|
const raw = await this.get<any[]>("/api/endpoints");
|
||||||
|
return (raw ?? []).map((e) => ({
|
||||||
|
id: e.Id,
|
||||||
|
name: e.Name,
|
||||||
|
type: e.Type,
|
||||||
|
url: e.URL,
|
||||||
|
status: e.Status,
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The stacks (compose/swarm deployments) Portainer knows about. */
|
||||||
|
async listStacks(): Promise<PortainerStack[]> {
|
||||||
|
const raw = await this.get<any[]>("/api/stacks");
|
||||||
|
return (raw ?? []).map((s) => ({
|
||||||
|
id: s.Id,
|
||||||
|
name: s.Name,
|
||||||
|
type: s.Type,
|
||||||
|
endpointId: s.EndpointId,
|
||||||
|
status: s.Status,
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The containers on one endpoint, read through Portainer's Docker API proxy. Includes stopped
|
||||||
|
* containers, so the caller sees the whole picture rather than only what is running.
|
||||||
|
*/
|
||||||
|
async listContainers(endpointId: number): Promise<PortainerContainer[]> {
|
||||||
|
const raw = await this.get<any[]>(`/api/endpoints/${endpointId}/docker/containers/json?all=1`);
|
||||||
|
return (raw ?? []).map((c) => ({
|
||||||
|
id: c.Id,
|
||||||
|
names: c.Names ?? [],
|
||||||
|
image: c.Image,
|
||||||
|
state: c.State,
|
||||||
|
status: c.Status,
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,114 @@
|
|||||||
|
{
|
||||||
|
"module": "portainer",
|
||||||
|
"version": "1",
|
||||||
|
"slug": "portain",
|
||||||
|
"capabilities": [
|
||||||
|
"container-runtime"
|
||||||
|
],
|
||||||
|
"listens": [
|
||||||
|
{
|
||||||
|
"name": "web",
|
||||||
|
"port": 9000,
|
||||||
|
"protocol": "tcp",
|
||||||
|
"from": "mesh",
|
||||||
|
"why": "the dashboard over http; its public name is a route grant and the proxy reaches it here"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "web-tls",
|
||||||
|
"port": 9443,
|
||||||
|
"protocol": "tcp",
|
||||||
|
"from": "mesh",
|
||||||
|
"why": "the same dashboard over its own tls; the runtime sidecar talks to it here"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"resources": [
|
||||||
|
{
|
||||||
|
"id": "mesh-state",
|
||||||
|
"type": "directory",
|
||||||
|
"mode": "0700",
|
||||||
|
"place": "mesh"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "data",
|
||||||
|
"type": "directory",
|
||||||
|
"mode": "0700"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "server",
|
||||||
|
"type": "container",
|
||||||
|
"name": "portainer",
|
||||||
|
"image": "portainer/portainer-ce@sha256:4d616db18cfeb5dd41a69c0958bc825c84483ea9cde1106eb82a5d26f3bd8b0e",
|
||||||
|
"ports": [
|
||||||
|
"9000",
|
||||||
|
"9443"
|
||||||
|
],
|
||||||
|
"volumes": [
|
||||||
|
"${dir:data}:/data",
|
||||||
|
"/var/run/docker.sock:/var/run/docker.sock"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "runtime-config",
|
||||||
|
"type": "file",
|
||||||
|
"path": "${dir:mesh-state}/config.json",
|
||||||
|
"mode": "0600",
|
||||||
|
"content": "{}\n",
|
||||||
|
"merge": "json"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "runtime",
|
||||||
|
"type": "container",
|
||||||
|
"name": "mesh-portainer",
|
||||||
|
"network": "host",
|
||||||
|
"volumes": [
|
||||||
|
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
||||||
|
"${dir:mesh-state}/config.json:/run/config/config.json:ro"
|
||||||
|
],
|
||||||
|
"env": {
|
||||||
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
"MESH_PORTAINER_URL": "https://127.0.0.1:9443",
|
||||||
|
"MESH_PORTAINER_CONFIG_FILE": "/run/config/config.json"
|
||||||
|
},
|
||||||
|
"restart-on": [
|
||||||
|
"runtime-config"
|
||||||
|
],
|
||||||
|
"artifact": "runtime"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"own-secrets": {
|
||||||
|
"broker": "${dir:mesh-state}/broker"
|
||||||
|
},
|
||||||
|
"build": {
|
||||||
|
"on": [
|
||||||
|
{
|
||||||
|
"arg": "BUILD_BASE",
|
||||||
|
"module": "mesh-tools",
|
||||||
|
"artifact": "build"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"arg": "RUNTIME_BASE",
|
||||||
|
"module": "mesh-tools",
|
||||||
|
"artifact": "runtime"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"artifacts": [
|
||||||
|
{
|
||||||
|
"name": "runtime",
|
||||||
|
"kind": "image",
|
||||||
|
"from": "Dockerfile"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"requires": [
|
||||||
|
"route"
|
||||||
|
],
|
||||||
|
"contributes": {
|
||||||
|
"route": {
|
||||||
|
"label": "portainer",
|
||||||
|
"endpoint": "web"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"binds": {
|
||||||
|
"route": "${dir:mesh-state}/route.json"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"name": "@novox/module-portainer",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "portainer — container management UI. Its API client and tools live here (novox/hq ADR 0039).",
|
||||||
|
"type": "module",
|
||||||
|
"private": true,
|
||||||
|
"dependencies": {
|
||||||
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/node": "^22.0.0",
|
||||||
|
"typescript": "^5.6.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
// portainer's tools — its own code (novox/hq ADR 0039), importing portainer's own client. They
|
||||||
|
// return structured data; the mesh serves them through the sdk's tool harness. portainer is
|
||||||
|
// tools-only (no events entrypoint): a container starting or stopping is the host's signal to emit,
|
||||||
|
// not Portainer's to re-announce.
|
||||||
|
|
||||||
|
import { registerModuleTools, type ToolDefinition } from "@novox/mesh-sdk/tools";
|
||||||
|
import { PortainerClient } from "../client.js";
|
||||||
|
|
||||||
|
export function getPortainerTools(portainer: PortainerClient): ToolDefinition[] {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
name: "portainer_endpoints",
|
||||||
|
description: "List the environments (endpoints) Portainer manages — each a Docker host or cluster.",
|
||||||
|
input: {},
|
||||||
|
run: async () => {
|
||||||
|
const endpoints = await portainer.listEndpoints();
|
||||||
|
return { count: endpoints.length, endpoints };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "portainer_stacks",
|
||||||
|
description: "List the stacks (compose/swarm deployments) Portainer knows about.",
|
||||||
|
input: {},
|
||||||
|
run: async () => {
|
||||||
|
const stacks = await portainer.listStacks();
|
||||||
|
return { count: stacks.length, stacks };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "portainer_containers",
|
||||||
|
description: "List the containers on one Portainer endpoint, including stopped ones.",
|
||||||
|
input: { endpoint: { type: "number", description: "the endpoint id (see portainer_endpoints)" } },
|
||||||
|
run: async (args) => {
|
||||||
|
const endpointId = Number(args.endpoint);
|
||||||
|
const containers = await portainer.listContainers(endpointId);
|
||||||
|
return { endpointId, count: containers.length, containers };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
// The tools exist only when a token is configured; without one, portainer contributes none rather
|
||||||
|
// than failing the whole runtime.
|
||||||
|
registerModuleTools("portainer", (env) => {
|
||||||
|
try {
|
||||||
|
return getPortainerTools(PortainerClient.fromEnv(env));
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "NodeNext",
|
||||||
|
"moduleResolution": "NodeNext",
|
||||||
|
"strict": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"noEmit": true
|
||||||
|
},
|
||||||
|
"include": ["client.ts", "tools/index.ts"]
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user