Musher Component Document

string — always COMPONENT

Document kind discriminator. Must be COMPONENT.

ComponentMetadata

ComponentSpec

string — one of v1

Version of the Musher specification this document is written against.

mapping, keyed by argumentName matching ^[A-Z_][A-Z0-9_]*$, to string

Build arguments keyed by argument name, injected into the image build context (Docker ARG). Build-time configuration only; runtime configuration rides on the workload's envVars and inputs.

ComponentBuildpacks

Build with Cloud Native Buildpacks.

string

Build with a Dockerfile, at this path relative to the repository root.

minLength 1

string

Buildpacks builder image.

minLength 1

string

Existing input receiving the connection apiKey role.

maxLength 64 · pattern "^[a-z][a-zA-Z0-9]{0,63}$"

string

Existing input receiving the connection baseURL role.

maxLength 64 · pattern "^[a-z][a-zA-Z0-9]{0,63}$"

string

Existing input receiving the connection model role.

maxLength 64 · pattern "^[a-z][a-zA-Z0-9]{0,63}$"

array of string — one of STREAMING, TOOL_CALLS

Required protocol features. Omission requires no optional capabilities.

uniqueItems true

ComponentConnectionInputs

string — one of OPENAI_CHAT_COMPLETIONS, ANTHROPIC_MESSAGES

Required client protocol, independent of upstream vendor.

mapping, keyed by requirementName matching ^[a-z][a-zA-Z0-9]{0,63}$, to ComponentConnectionRequirement

Atomic connection requirements; each member input has exactly one owner. See spec.md §6.4.

mapping, keyed by inputName matching ^[a-z][a-zA-Z0-9]{0,63}$, to ComponentInput

Typed input declarations keyed by input name.

mapping, keyed by outputName matching ^[a-z][a-zA-Z0-9]{0,63}$, to ComponentOutput

Typed output declarations keyed by output name.

string — one of HTTP, HTTPS, WS, GRPC, TCP, UDP

Protocol served on the port: HTTP, HTTPS, WS, GRPC, TCP, or UDP.

integer

Port the workload listens on, where traffic for this endpoint is forwarded. Never the public port, which the platform allocates. A port below 1024 is structurally valid; admission may reject it as a capability check.

minimum 1 · maximum 65535

string

Branch to build from. A request, not a pin: the branch moves.

minLength 1

string

Commit to build from. Identifies source, not every build input.

minLength 1

ComponentBuild

How the repository is built into an image. Required: a Git source has no image until something builds one, and leaving the strategy implicit makes the resulting image depend on the builder rather than on this document.

ComponentGitRef

Branch or commit to build from. Omitted, the repository default branch.

string

Git repository URL the platform builds into an image.

minLength 1

ComponentProbe

Aliveness gate; failure restarts the workload. Optional.

ComponentProbe

Traffic gate; failure pulls the replica from routing without a restart. Required for a SERVICE exposing a public endpoint.

ComponentProbe

Initialization gate; failure means not-yet-started. Optional.

string

Named endpoint serving HTTP or HTTPS.

pattern "^[a-z][a-z0-9]{0,19}$"

string

Absolute HTTP path the platform requests.

pattern "^/"

any value

Logical fallback used only when no binding is declared.

string

What this input means.

minLength 1

string — one of EMAIL, URI, ENDPOINT_URL, CONNECTION_STRING, HOSTNAME, TIMEZONE

Optional presentation annotation, not a value constraint.

boolean

Whether absence is forbidden; defaults to true.

documented default true

ComponentValueSchema

Logical JSON value contract.

boolean

True when the value is secret material: handled as a secret reference, masked in UIs, never echoed back.

documented default false

ComponentInputTarget

Environment destination; required on workload inputs.

string

Environment variable the resolved value is bound into at runtime materialisation (e.g. ADMIN_EMAIL). Uppercase letters, digits, and underscores; must not start with a digit.

minLength 1 · maxLength 128 · pattern "^[A-Z_][A-Z0-9_]*$"

string

What this component is, in one or two plain-text sentences.

minLength 1 · maxLength 280

integer

Lineage revision of this component. Required (never defaulted) so the component's content is a pure function of this file, and it is the revision the item's blueprint nodes pin.

minimum 1

string

What this output means.

minLength 1

ComponentOutputFrom

string — one of EMAIL, URI, ENDPOINT_URL, CONNECTION_STRING, HOSTNAME, TIMEZONE

Optional presentation annotation.

ComponentValueSchema

Logical JSON value contract.

boolean

True when the value is secret material: handled as a secret reference, masked in UIs, never echoed back.

documented default false

string

Own endpoint whose allocated address property is read.

pattern "^[a-z][a-z0-9]{0,19}$"

string

Own input forwarded as this output, keeping its sensitivity.

maxLength 64 · pattern "^[a-z][a-zA-Z0-9]{0,63}$"

string — one of publicURL, publicHostname, publicAddress, publicPort, privateHostname, privatePort, privateAddress

Address property of the named endpoint.

string

String with ${{ self.endpoints.. }} references, substituted once.

maxLength 65536

any value

Logical non-secret literal value.

integer

Consecutive failures required to consider the probe failing.

minimum 1 · documented default 3

ComponentHttpProbe

integer

Seconds to wait after start before the first probe.

minimum 0 · documented default 10

integer

Seconds between consecutive probe attempts.

minimum 1 · documented default 10

integer

Consecutive successes required to consider the probe passing.

minimum 1 · documented default 1

integer

Seconds to wait for a probe response.

minimum 1 · documented default 5

string

Five-field cron expression, evaluated in UTC, on which the JOB recurs.

maxLength 128 · pattern "^[^ \\t]+(?:[ \\t]+[^ \\t]+){4}$"

ComponentGitSource

A Git repository the platform builds into an image.

ComponentImageReference

ComponentContract

The composition contract: typed inputs the component needs and outputs it publishes.

string — one of SERVICE, WORKER, JOB, EXTERNAL

Category of the node: SERVICE (long-running, request-driven, at least one endpoint), WORKER (long-running, not request-driven; endpoints optional and never public), JOB (runs to completion, once per rollout or on a schedule), or EXTERNAL (not run by this platform).

ComponentWorkload

How the platform runs the component: source, command, endpoints, environment, storage and health. Required unless type is EXTERNAL, and forbidden when it is.

boolean — always false

array

minItems 1 · uniqueItems true

number

number

ComponentValueSchema

integer

minimum 0

integer

minimum 0

number

integer

minimum 0

integer

minimum 0

number

string

maxLength 256

mapping, keyed by propertyName, to ComponentValueSchema

array of string

uniqueItems true

string — one of string, integer, number, boolean, null, array, object

boolean

integer

Smallest allocation the component can run with. The blueprint allocates at least this.

minimum 1

string

Absolute path where the volume is mounted in the workload.

maxLength 512 · pattern "^/"

boolean

True when the volume is mounted read-only.

documented default false

boolean

True when every replica mounts the same volume at once. False, the volume attaches to one replica at a time.

documented default false

array of string

Arguments the workload runs, as a list, with no shell. Replaces the image CMD and keeps its ENTRYPOINT. Required for a JOB.

minItems 1

mapping, keyed by endpointName matching ^[a-z][a-z0-9]{0,19}$, to ComponentEndpoint

Named ports the workload listens on. Required on a SERVICE, optional on a WORKER (never exposed publicly), forbidden on a JOB.

mapping, keyed by envVarName matching ^[A-Z_][A-Z0-9_]*$, to string

Intrinsic non-secret environment constants, keyed by variable name. Configurable values are inputs with a target, supplied by the blueprint.

ComponentHealthProbes

Staged health probes (startup, readiness, liveness). Omitted when none are defined; forbidden on a JOB.

ComponentSchedule

Makes a JOB recur. Omitted, the job runs once per rollout. Forbidden on every other type.

ComponentSource

Where the workload image comes from: a pinned image, or a Git repository the platform builds.

mapping, keyed by volumeName matching ^[a-z][a-z0-9-]{0,61}[a-z0-9]$, to ComponentVolume

Persistent storage the workload mounts, with the minimum size each needs.