edge.forms.takoform.com/WorkerEndpoint@0.1.0

Worker Endpoint

Expose the active deployment at a Host-assigned HTTPS address.

Public package readback verified

Host support and admission are separate from package publication. These fields describe portable desired state, not a provider-specific deployment command.

How it fits

Do not supply a hostname. The Host returns an address that stays fixed for the attachment UID, including when deployments change.

Works with: Module Worker · Worker Deployment · Worker Custom Domain

Full contract description

Makes one Module Worker reachable over HTTPS at an address the HOST assigns, with no customer-owned domain and no DNS of the author's. The desired state is the worker and nothing else: the author asks for reachability, and where that reachability lives is the host's decision, exactly as an account, a region, and a vendor subdomain are. Requests arriving at the address invoke the fetch handler of the worker's ACTIVE DEPLOYMENT, so promotion and rollback move what answers without the endpoint being re-applied and without its address changing. The scheme is https and the path root is `/`; TLS is not an option a host may decline, because an address that is only reachable in plaintext is a different promise from the one this Form makes. A worker has AT MOST ONE endpoint: two would be two addresses for one service with nothing saying which is canonical, and the second is refused. The assigned address is published as outputs — a portable author may rely on a value being returned, on its scheme being https, and on it routing to the active deployment, and on nothing about its SHAPE: which subdomain, which apex, and how long the label is are host detail no portable configuration may parse or reconstruct. The address is IMMUTABLE for the lifetime of the endpoint's attachment UID. It MUST NOT change on deployment promotion, on status refresh, on a host's internal placement change, or on a backend migration; a host that needs to change the address deletes the endpoint and the author creates a new one, which is a new attachment with a new UID.

Kind: WorkerEndpoint
Definition version: 0.1.0
Role: attachment

Desired state

workerRequired · object: Module Worker whose active deployment answers requests at the assigned address. Changing it replaces the endpoint.
additionalProperties: false

Example desired state

This is the exact fixtures/desired.json from this package, not a complete Host API request or OpenTofu configuration. Replace example resource references and artifact digests with your own; it does not provision anything by itself.

{
  "worker": {
    "apiVersion": "edge.forms.takoform.com",
    "kind": "ModuleWorker",
    "name": "module-worker"
  }
}

Read source fixture

Full desired-state schema

Nested fields, allowed alternatives and all schema constraints. Host-validated semantics also apply; read the contract description above.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "description": "Makes one Module Worker reachable over HTTPS at an address the HOST assigns, with no customer-owned domain and no DNS of the author's. The desired state is the worker and nothing else: the author asks for reachability, and where that reachability lives is the host's decision, exactly as an account, a region, and a vendor subdomain are. Requests arriving at the address invoke the fetch handler of the worker's ACTIVE DEPLOYMENT, so promotion and rollback move what answers without the endpoint being re-applied and without its address changing. The scheme is https and the path root is `/`; TLS is not an option a host may decline, because an address that is only reachable in plaintext is a different promise from the one this Form makes. A worker has AT MOST ONE endpoint: two would be two addresses for one service with nothing saying which is canonical, and the second is refused. The assigned address is published as outputs — a portable author may rely on a value being returned, on its scheme being https, and on it routing to the active deployment, and on nothing about its SHAPE: which subdomain, which apex, and how long the label is are host detail no portable configuration may parse or reconstruct. The address is IMMUTABLE for the lifetime of the endpoint's attachment UID. It MUST NOT change on deployment promotion, on status refresh, on a host's internal placement change, or on a backend migration; a host that needs to change the address deletes the endpoint and the author creates a new one, which is a new attachment with a new UID.",
  "properties": {
    "worker": {
      "additionalProperties": false,
      "description": "Module Worker whose active deployment answers requests at the assigned address. Changing it replaces the endpoint.",
      "properties": {
        "apiVersion": {
          "const": "edge.forms.takoform.com",
          "type": "string"
        },
        "kind": {
          "const": "ModuleWorker",
          "type": "string"
        },
        "name": {
          "maxLength": 63,
          "minLength": 1,
          "pattern": "^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$",
          "type": "string"
        }
      },
      "required": [
        "apiVersion",
        "kind",
        "name"
      ],
      "type": "object",
      "x-takoform-required-entrypoint": "fetch",
      "x-takoform-required-interface": {
        "apiVersion": "interfaces.takoform.com/v1alpha1",
        "name": "worker.runtime",
        "schemaDigest": "sha256:ed2f8211aac5be94488d391945ca6aca7627a4ecbd261e39790093e887feae08",
        "version": "1.1.0"
      }
    }
  },
  "required": [
    "worker"
  ],
  "title": "Worker Endpoint desired state",
  "type": "object"
}

Lifecycle

create
read
delete
import
observe

Provided interfaces

None

Canonical package locator

Package digest: sha256:e68431e901e44768b9ceb4a4b95fc0d12a9930decd505c56cfe26ad9f51bdc3a
Schema digest: sha256:732f60aba45ce360d5ebbc6ac2e55fe4d59b65d353f4628e93960d71fbc2870f
Tag: forms/k-mvsgozjomzxxe3ltfz2gc23pmzxxe3jomnxw2l2xn5zgwzlsivxgi4dpnfxhi/sha256-e68431e901e44768b9ceb4a4b95fc0d12a9930decd505c56cfe26ad9f51bdc3a
Source path: forms/releases/k-mvsgozjomzxxe3ltfz2gc23pmzxxe3jomnxw2l2xn5zgwzlsivxgi4dpnfxhi/sha256-e68431e901e44768b9ceb4a4b95fc0d12a9930decd505c56cfe26ad9f51bdc3a
Signed set: e7f8a39311dd011b8467e97e7f300cabb9a6b06c

Open immutable package

Four-field FormRef

{
  "apiVersion": "edge.forms.takoform.com",
  "kind": "WorkerEndpoint",
  "definitionVersion": "0.1.0",
  "schemaDigest": "sha256:732f60aba45ce360d5ebbc6ac2e55fe4d59b65d353f4628e93960d71fbc2870f"
}