@toa.io/operations 1.0.0-alpha.27 → 1.0.0-alpha.270

package/CHANGELOG.md

@@ -0,0 +1,109 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [1.0.0-alpha.270](https://github.com/toa-io/toa/compare/v1.0.0-alpha.269...v1.0.0-alpha.270) (2026-08-31)
+
+
+### Bug Fixes
+
+* **operations:** let a composition set its own base image ([61ba331](https://github.com/toa-io/toa/commit/61ba3319dc91915a3197d348111af411bbd5bff1))
+
+
+
+
+
+# [1.0.0-alpha.266](https://github.com/toa-io/toa/compare/v1.0.0-alpha.265...v1.0.0-alpha.266) (2026-08-29)
+
+**Note:** Version bump only for package @toa.io/operations
+
+
+
+
+
+# [1.0.0-alpha.265](https://github.com/toa-io/toa/compare/v1.0.0-alpha.264...v1.0.0-alpha.265) (2026-08-29)
+
+**Note:** Version bump only for package @toa.io/operations
+
+
+
+
+
+# [1.0.0-alpha.264](https://github.com/toa-io/toa/compare/v1.0.0-alpha.263...v1.0.0-alpha.264) (2026-08-29)
+
+**Note:** Version bump only for package @toa.io/operations
+
+
+
+
+
+# [1.0.0-alpha.263](https://github.com/toa-io/toa/compare/v1.0.0-alpha.262...v1.0.0-alpha.263) (2026-08-29)
+
+**Note:** Version bump only for package @toa.io/operations
+
+
+
+
+
+# [1.0.0-alpha.262](https://github.com/toa-io/toa/compare/v1.0.0-alpha.261...v1.0.0-alpha.262) (2026-08-28)
+
+
+### Bug Fixes
+
+* **cli:** boot toa mono from components and env, not context ([1518f72](https://github.com/toa-io/toa/commit/1518f729d7611ae88e0538f286231d283a7098ef))
+
+
+* feat(operations)!: require service ports to be unique ([b22cf87](https://github.com/toa-io/toa/commit/b22cf8770d24c555b5f355a5f117a9043a57799b))
+
+
+### Features
+
+* **operations:** let a service claim a path prefix on the host ([02677d1](https://github.com/toa-io/toa/commit/02677d17fcd4222b07c3be458d93bcc496a016a8))
+
+
+### BREAKING CHANGES
+
+* an application whose own extension runs a service on a port
+already taken by another — 8000 by the exposition gateway, 8001 by the telemetry
+readiness probe — must move it.
+
+Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
+
+
+
+
+
+# [1.0.0-alpha.261](https://github.com/toa-io/toa/compare/v1.0.0-alpha.260...v1.0.0-alpha.261) (2026-08-26)
+
+
+### Bug Fixes
+
+* **operations:** include extension pointer variables in --mono ([f8be23d](https://github.com/toa-io/toa/commit/f8be23d2aaf7bbe1b0580101c8bf4d32c3cab99f))
+
+
+
+
+
+# [1.0.0-alpha.259](https://github.com/toa-io/toa/compare/v1.0.0-alpha.258...v1.0.0-alpha.259) (2026-08-24)
+
+**Note:** Version bump only for package @toa.io/operations
+
+
+
+
+
+# [1.0.0-alpha.257](https://github.com/toa-io/toa/compare/v1.0.0-alpha.256...v1.0.0-alpha.257) (2026-08-24)
+
+**Note:** Version bump only for package @toa.io/operations
+
+
+
+
+
+# [1.0.0-alpha.256](https://github.com/toa-io/toa/compare/v1.0.0-alpha.255...v1.0.0-alpha.256) (2026-08-23)
+
+
+### Features
+
+* deploy a single mono image with toa deploy --mono ([a7f14f9](https://github.com/toa-io/toa/commit/a7f14f9877a280e9c74d16c195028b35d74fb15a))

package/image/runtime.Dockerfile

@@ -0,0 +1,4 @@
+FROM node:24.14.0-alpine3.22
+
+ARG VERSION
+RUN npm i -g @toa.io/runtime@${VERSION} --omit=dev

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/operations",
-  "version": "1.0.0-alpha.27",
+  "version": "1.0.0-alpha.270",
   "description": "Toa Deployment",
   "homepage": "https://toa.io",
   "author": {
@@ -16,23 +16,23 @@
     "url": "https://github.com/toa-io/toa/issues"
   },
   "engines": {
-    "node": ">= 18.0.0"
+    "node": ">= 24.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "main": "src/index.js",
-  "types": "types/index.d.ts",
+  "types": "types/index.ts",
   "scripts": {
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@toa.io/filesystem": "1.0.0-alpha.27",
-    "@toa.io/generic": "1.0.0-alpha.27",
-    "@toa.io/norm": "1.0.0-alpha.27",
-    "@toa.io/yaml": "1.0.0-alpha.27",
+    "@toa.io/filesystem": "1.0.0-alpha.254",
+    "@toa.io/generic": "1.0.0-alpha.254",
+    "@toa.io/norm": "1.0.0-alpha.270",
+    "@toa.io/yaml": "1.0.0-alpha.254",
     "execa": "5.1.1",
     "fs-extra": "11.1.1"
   },
-  "gitHead": "9bc4bdb919688c5272791020746f70d51a520750"
+  "gitHead": "94400bdd411b4c25074ffcf58184580ddd060268"
 }

package/readme.md

@@ -4,6 +4,22 @@
 
 ### Container Registry
 
+Deploy images default to `FROM ghcr.io/toa-io/runtime:<runtime.version>`
+(published with each Toa release). The base image already has `@toa.io/runtime`
+installed; composition/service Dockerfiles only install component dependencies.
+
+To use a custom base image, set `registry.build.image` (or `composition.image`).
+That image must provide the `toa` CLI, or install it via `registry.build.run`:
+
+```yaml
+# context.toa.yaml
+
+registry:
+  build:
+    image: node:24.14.0-alpine3.22
+    run: npm i -g @toa.io/runtime --omit=dev
+```
+
 #### Build Options
 
 ```yaml

package/src/deployment/.deployment/.describe/compositions.js

@@ -1,10 +1,15 @@
 'use strict'
 
 const { addVariables } = require('./variables')
+const { addMounts } = require('./mounts')
 
-function compositions (compositions, variables) {
+function compositions (compositions, dependency) {
   for (const composition of compositions) {
-    addVariables(composition, variables)
+    addVariables(composition, dependency.variables)
+    addMounts(composition, dependency.mounts)
+
+    if (dependency.probe !== undefined && dependency.probe !== false)
+      composition.probe ??= dependency.probe
   }
 }
 

package/src/deployment/.deployment/.describe/mounts.js

@@ -0,0 +1,24 @@
+'use strict'
+
+function addMounts (composition, mounts, keys = composition.components) {
+  if (mounts === undefined)
+    return
+
+  const used = new Set()
+
+  for (const [key, mount] of Object.entries(mounts)) {
+    if (key !== 'global' && !keys?.includes(key))
+      continue
+
+    for (const { name, path, claim } of mount) {
+      if (used.has(name))
+        continue
+
+      composition.mounts ??= []
+      composition.mounts.push({ name, path, claim })
+      used.add(name)
+    }
+  }
+}
+
+exports.addMounts = addMounts

package/src/deployment/.deployment/.describe/resources.js

@@ -0,0 +1,37 @@
+'use strict'
+
+/**
+ * Every deployment states what it may take. One that states nothing is `BestEffort`: the
+ * first evicted under memory pressure and the last given CPU under contention — which on
+ * a busy node is slow enough for its own startup probe to kill it, in a loop, while the
+ * chart reports nothing wrong. That is not a thing to find out in production.
+ *
+ * A deployment takes its own declaration, or the context's `resources` where it has none.
+ * Deploying without any is a decision rather than an omission, and it is spelled
+ * `resources: null` — at either place.
+ */
+function resources (context, values) {
+  for (const unit of units(values)) {
+    // `null` is an answer and `undefined` is not one, so the fallback reads only the latter
+    if (unit.deployment.resources === undefined)
+      unit.deployment.resources = context.resources
+
+    if (unit.deployment.resources === undefined)
+      throw new Error(`${unit.subject} declares no resources. ` +
+        'Declare them on it or as the context\'s \'resources\', ' +
+        'or \'resources: null\' to deploy it without any.')
+  }
+}
+
+function * units (values) {
+  if (values.mono !== undefined)
+    yield { deployment: values.mono, subject: 'The mono deployment' }
+
+  for (const composition of values.compositions ?? [])
+    yield { deployment: composition, subject: `Composition '${composition.name}'` }
+
+  for (const service of values.services ?? [])
+    yield { deployment: service, subject: `Service '${service.name}'` }
+}
+
+exports.resources = resources

package/src/deployment/.deployment/.describe/services.js

@@ -2,10 +2,37 @@
 
 const { addVariables } = require('./variables')
 
-function services (services, variables) {
+function services (services, variables, probe, ingress) {
   for (const service of services) {
     addVariables(service, variables)
+
+    if (service.probe === false)
+      delete service.probe
+    else if (service.probe === undefined && probe !== undefined && probe !== false)
+      service.probe = probe
+
+    if (service.ingress !== undefined)
+      expose(service, ingress)
   }
 }
 
+/**
+ * A service declares only its own intent — a path, a port. Where that lands is
+ * the context's business, so everything else comes from its `ingress` section.
+ * What the service did declare wins.
+ */
+function expose (service, ingress = {}) {
+  const declared = Object.fromEntries(
+    Object.entries(service.ingress).filter(([, value]) => value !== undefined))
+
+  service.ingress = Object.assign({}, ingress, declared)
+
+  if (service.ingress.hosts === undefined)
+    throw new Error(`Service '${service.name}' declares an ingress, but no hosts are defined. ` +
+      "Declare them in the context's 'ingress' section.")
+
+  if (service.port === undefined)
+    throw new Error(`Service '${service.name}' declares an ingress, but no port.`)
+}
+
 exports.services = services

package/src/deployment/.deployment/.describe/services.test.js

@@ -0,0 +1,61 @@
+'use strict'
+
+const { services } = require('./services')
+
+const service = (extra = {}) => ({ group: 'group', name: 'group-one', version: '0', ...extra })
+
+it('should leave a service without an ingress alone', () => {
+  const list = [service()]
+
+  services(list, {}, undefined, { hosts: ['api.dev'] })
+
+  expect(list[0].ingress).toBeUndefined()
+})
+
+/*
+ * A service declares only where it wants to land; the cluster-level plumbing
+ * belongs to the context.
+ */
+it('should supply hosts, class and annotations from the context', () => {
+  const list = [service({ port: 8002, ingress: { path: '/.introspection' } })]
+
+  services(list, {}, undefined, { hosts: ['api.dev'], class: 'alb', annotations: { a: 'b' } })
+
+  expect(list[0].ingress).toStrictEqual({
+    path: '/.introspection',
+    hosts: ['api.dev'],
+    class: 'alb',
+    annotations: { a: 'b' }
+  })
+})
+
+it('should keep what the service declared itself', () => {
+  const list = [service({ port: 8000, ingress: { path: '/', hosts: ['own.dev'] } })]
+
+  services(list, {}, undefined, { hosts: ['api.dev'], class: 'alb' })
+
+  expect(list[0].ingress.hosts).toStrictEqual(['own.dev'])
+  expect(list[0].ingress.class).toStrictEqual('alb')
+})
+
+it('should ignore properties the service left undefined', () => {
+  const list = [service({ port: 8000, ingress: { path: '/', class: undefined } })]
+
+  services(list, {}, undefined, { hosts: ['api.dev'], class: 'alb' })
+
+  expect(list[0].ingress.class).toStrictEqual('alb')
+})
+
+it('should reject an ingress with nowhere to land', () => {
+  const list = [service({ port: 8002, ingress: { path: '/.introspection' } })]
+
+  expect(() => services(list, {}, undefined, undefined))
+    .toThrow("Service 'group-one' declares an ingress, but no hosts are defined")
+})
+
+it('should reject an ingress without a port', () => {
+  const list = [service({ ingress: { path: '/.introspection' } })]
+
+  expect(() => services(list, {}, undefined, { hosts: ['api.dev'] }))
+    .toThrow("Service 'group-one' declares an ingress, but no port")
+})

package/src/deployment/.deployment/.describe/variables.js

@@ -1,17 +1,18 @@
 'use strict'
 
-function addVariables (deployment, variables) {
-  const used = new Set()
+function addVariables (composition, variables, keys = composition.components) {
+  composition.variables ??= []
 
-  deployment.variables ??= []
+  const used = new Set(composition.variables.map((variable) => variable.name))
 
   for (const [key, set] of Object.entries(variables)) {
-    if (key !== 'global' && !deployment.components?.includes(key)) continue
+    if (key !== 'global' && !keys?.includes(key))
+      continue
 
     for (const variable of set) {
       if (used.has(variable.name)) continue
 
-      deployment.variables.push(variable)
+      composition.variables.push(variable)
       used.add(variable.name)
     }
   }

package/src/deployment/.deployment/describe.js

@@ -1,8 +1,11 @@
 'use strict'
 
-const get = require('./.describe')
+const desc = require('./.describe')
+const { addVariables } = require('./.describe/variables')
+const { addMounts } = require('./.describe/mounts')
+const { resources } = require('./.describe/resources')
 
-const describe = (context, compositions, dependency) => {
+const describe = (context, compositions, dependency, image) => {
   const { services } = dependency
 
   dependency.variables.global ??= []
@@ -17,18 +20,93 @@ const describe = (context, compositions, dependency) => {
     }
   )
 
-  const components = get.components(compositions)
   const credentials = context.registry?.credentials
 
-  get.compositions(compositions, dependency.variables, context.environment)
-  get.services(services, dependency.variables)
+  if (image !== undefined) {
+    const mono = unit(context, dependency)
 
-  return {
+    mono.image = image.reference
+
+    const values = {
+      compositions: [],
+      components: mono.components,
+      services: [],
+      credentials,
+      mono
+    }
+
+    resources(context, values)
+
+    return values
+  }
+
+  const components = desc.components(compositions)
+
+  desc.compositions(compositions, dependency)
+  desc.services(services, dependency.variables, dependency.probe, context.ingress)
+
+  const values = {
     compositions,
     components,
     services,
     credentials
   }
+
+  resources(context, values)
+
+  return values
+}
+
+function unit (context, dependency) {
+  const components = (context.components ?? []).map((component) => component.locator.label)
+
+  const variables = dependency.variables ?? {}
+  const mounts = dependency.mounts ?? {}
+
+  const mono = {
+    replicas: context.mono?.replicas,
+    resources: context.mono?.resources,
+    components,
+    variables: []
+  }
+
+  if (context.ingress !== undefined)
+    mono.ingress = Object.assign({}, context.ingress)
+
+  addVariables(mono, variables, Object.keys(variables))
+  addMounts(mono, dependency.mounts, Object.keys(mounts))
+
+  for (const service of dependency.services ?? []) {
+    if (service.variables !== undefined)
+      for (const variable of service.variables)
+        if (!mono.variables.some((item) => item.name === variable.name))
+          mono.variables.push(variable)
+
+    // every declared port is bound by the single mono process, none is primary
+    if (service.port !== undefined)
+      (mono.backends ??= []).push({ port: service.port, path: service.ingress?.path ?? '/' })
+
+    if (service.ingress !== undefined) {
+      const { path, hosts, ...ingress } = service.ingress
+
+      mono.ingress = Object.assign(mono.ingress ?? {}, ingress)
+
+      // one Ingress serves every path, so its hosts are the union, not the last word
+      if (hosts !== undefined)
+        mono.ingress.hosts = [...new Set([...(mono.ingress.hosts ?? []), ...hosts])]
+    }
+
+    if (service.probe !== undefined && service.probe !== false)
+      mono.probe = service.probe
+  }
+
+  if (mono.probe === undefined && dependency.probe !== undefined && dependency.probe !== false)
+    mono.probe = dependency.probe
+
+  // the more specific prefix must come first, whatever the controller's tie-break
+  mono.backends?.sort((a, b) => b.path.length - a.path.length)
+
+  return mono
 }
 
 exports.describe = describe

package/src/deployment/.deployment/merge.js

@@ -13,14 +13,54 @@ const merge = (dependencies) => {
   /** @type {toa.deployment.dependency.Variables} */
   const variables = {}
 
+  const mounts = {}
+
+  /** @type {toa.deployment.dependency.Probe | false | undefined} */
+  let probe
+
   for (const dependency of dependencies) {
     if (dependency.references !== undefined) references.push(...dependency.references)
     if (dependency.services !== undefined) services.push(...dependency.services)
     if (dependency.proxies !== undefined) proxies.push(...dependency.proxies)
     if (dependency.variables !== undefined) append(variables, dependency.variables)
+    if (dependency.mounts !== undefined) append(mounts, dependency.mounts)
+    if (dependency.probe !== undefined) probe = dependency.probe
   }
 
-  return { references, services, proxies, variables }
+  reserve(services, probe)
+
+  return { references, services, proxies, variables, mounts, probe }
+}
+
+/**
+ * In Kubernetes these are separate pods, but `toa mono` and a local run put every
+ * service in one process — so a port may be claimed once and only once.
+ */
+const reserve = (services, probe) => {
+  const claimed = new Map()
+
+  if (probe !== undefined && probe !== false)
+    claimed.set(probe.port, 'the readiness probe')
+
+  for (const service of services)
+    for (const [port, claimant] of ports(service)) {
+      const conflicting = claimed.get(port)
+
+      if (conflicting !== undefined)
+        throw new Error(`Port ${port} is claimed by both ${conflicting} and ${claimant}`)
+
+      claimed.set(port, claimant)
+    }
+}
+
+function * ports (service) {
+  const name = `'${service.group}-${service.name}'`
+
+  if (service.port !== undefined)
+    yield [service.port, name]
+
+  if (service.probe !== undefined && service.probe !== false && service.probe.port !== service.port)
+    yield [service.probe.port, `the readiness probe of ${name}`]
 }
 
 const append = (merged, variables) => {

package/src/deployment/.deployment/merge.test.js

@@ -0,0 +1,74 @@
+'use strict'
+
+const { merge } = require('./merge')
+
+const service = (name, extra = {}) => ({ group: 'group', name, version: '0', ...extra })
+
+it('should merge services of all dependencies', () => {
+  const merged = merge([
+    { services: [service('one', { port: 8000 })] },
+    { services: [service('two', { port: 8001 })] }
+  ])
+
+  expect(merged.services).toHaveLength(2)
+})
+
+/*
+ * In Kubernetes these are separate pods, but `toa mono` and a local run put every
+ * service in one process.
+ */
+describe('port reservation', () => {
+  it('should reject two services claiming one port', () => {
+    const dependencies = [
+      { services: [service('one', { port: 8000 })] },
+      { services: [service('two', { port: 8000 })] }
+    ]
+
+    expect(() => merge(dependencies))
+      .toThrow("Port 8000 is claimed by both 'group-one' and 'group-two'")
+  })
+
+  it('should reject a service claiming the port of the readiness probe', () => {
+    const dependencies = [
+      { probe: { path: '/.ready', port: 8001 } },
+      { services: [service('one', { port: 8001 })] }
+    ]
+
+    expect(() => merge(dependencies))
+      .toThrow("Port 8001 is claimed by both the readiness probe and 'group-one'")
+  })
+
+  it('should reject a probe claiming the port of another service', () => {
+    const dependencies = [
+      { services: [service('one', { port: 8000 })] },
+      { services: [service('two', { port: 8002, probe: { path: '/.ready', port: 8000 } })] }
+    ]
+
+    expect(() => merge(dependencies))
+      .toThrow("Port 8000 is claimed by both 'group-one' and the readiness probe of 'group-two'")
+  })
+
+  it('should allow a service to probe its own port', () => {
+    const dependencies = [
+      { services: [service('one', { port: 8000, probe: { path: '/.ready', port: 8000 } })] }
+    ]
+
+    expect(() => merge(dependencies)).not.toThrow()
+  })
+
+  it('should ignore services without a port', () => {
+    const dependencies = [
+      { services: [service('one'), service('two')] }
+    ]
+
+    expect(() => merge(dependencies)).not.toThrow()
+  })
+
+  it('should ignore a disabled probe', () => {
+    const dependencies = [
+      { probe: false, services: [service('one', { port: 8000, probe: false })] }
+    ]
+
+    expect(() => merge(dependencies)).not.toThrow()
+  })
+})