programRef | reference to Program | yes | | | The program to run; it must be Ready. Point it at another program to roll out a new version. |
desiredState | string (one of) | | "Running" | Running, Suspended, Stopped, Hibernated | Running; Suspended keeps the state and interfaces but delivers nothing; Stopped deletes the state; Hibernated writes a snapshot of the process (memory included) to the hibernation bucket and releases it, and Running later continues it from there, on any machine that reaches its VPCs (needs spec.hibernation). |
monitoringRef | reference to MonitoringWorkspace | | | | Optional MonitoringWorkspace to send process logs and fuel/CPU metrics to. |
interfaces | list of object | | | up to 8 items | Virtual Ethernet interfaces, each a port on a VPC. At most 8. |
interfaces[].name | string | yes | | length 1 to 63 | Interface name, unique in the process (a DNS label). |
interfaces[].vpcRef | reference to VPC | yes | | | The VPC this interface is a port on. |
interfaces[].mtu | integer | | | 576 to 1500 | Largest payload of a frame; defaults to the VPC's and is capped by it. |
config | object | | | | Settings the program reads by key. Not secret. At most 64 entries and 16 KiB in total. |
resources | object | | {} | | How much the process may use. |
resources.cpuShare | integer | | 10 | 1 to 100 | Relative share when processes compete for the same processor, on top of the allowance in cpuMillicores. |
resources.memoryPower | integer | | 4 | 0 to 12 | Memory the process may use, as a power of two of 64 KiB: 0 is 64 KiB, 1 is 128 KiB, 2 is 256 KiB, 3 is 512 KiB, 4 is 1 MiB (the default), and so on up to 12, which is 256 MiB, the most any process may have (no one is exempt). A program that needs more at start-up is refused; one that grows past it fails. |
resources.cpuMillicores | integer | | 100 | 1 to 1000 | Processor time the process may use on average, in thousandths of one core: 100 is a tenth of a core (the default), 1000 a whole core. Short bursts above it are allowed; work beyond the allowance waits. |
resources.stateMaxBytes | integer | | 65536 | 0 to 1048576 | Largest durable state the program may keep, in bytes. |
resources.maxCpuMillicores | integer | | | 1 to 1000 | The most cpuMillicores an automatic remediation may raise this process to when it runs out of fuel (spec 0020 'Remediation'). Unset: one core. |
schedules | list of object | | | up to 8 items | Times at which the process is woken by itself, with no frame involved. At most 8. |
schedules[].name | string | yes | | length 1 to 63 | Schedule name, unique in the process; passed to the program when it ticks. |
schedules[].cron | string | | | up to 100 characters | Five fields in UTC: minute hour day-of-month month day-of-week; lists, ranges and steps. Exactly one of cron and everySeconds. |
schedules[].everySeconds | integer | | | 1 to 86400 | Fixed interval in seconds, counted from startsAt. Exactly one of cron and everySeconds. |
schedules[].startsAt | string | | | | RFC 3339 time the interval is counted from; defaults to the creation time. |
placement | object | | {} | | Where the process lives. |
placement.region | string | | "auto" | up to 32 characters | auto (next to its VPCs) or a region such as eu, us or apac. |
placement.affinityGroup | string | | | up to 63 characters | Affinity: processes of one project with the same group run on the same node. The first member is claimed by any node; the others only by the node that holds a member. A node that lost its members releases them all, and the group starts again. |
placement.spreadGroup | string | | | up to 63 characters | Anti-affinity: processes of one project with the same group never run on the same node (the nodes of one Ingress run on different stations). A process waits (NoNode) while every node holds a member of its group. |
placement.host | string | | | up to 63 characters | Platform processes only: the one machine (the name of a node or a gateway) that may host the process. Set by the placement controller (spec 0047 section 4); a machine with another name leaves the process alone. |
egress | list of object | | | up to 16 items | Platform processes only: the HTTPS hosts the program may call with the host function http (spec 0021 'Calling out'). Nothing else is reachable from the program. |
egress[].host | string | yes | | length 3 to 253 | A DNS name, for example api.example.com, or *.example.com for every name under example.com. Never an address. |
egress[].port | integer | | 443 | 1 to 65535 | The port. |
restartRequestedAt | string | | | up to 40 characters | RFC 3339 time. Set it to now to restart the process: a machine that hosts it starts a new life of it when this value changes (a process that is Failed and waiting for its backoff starts at once). A remediation does this for a failing process. |
restartPolicy | string (one of) | | "Always" | Always, OnFailure, Never | Whether a process that failed five times in a row is started again after a backoff. |
residency | string (one of) | | "Ephemeral" | Ephemeral, Resident | Ephemeral: a fresh instance for every wake-up. Resident: the instance and its memory stay between wake-ups (for programs that hold connections); a failure or a restart begins it again. |
wake | object | | {} | | How a sleeping (hibernated) process is woken. A magic frame (Wake-on-LAN, EtherType 0x0842 or UDP port 7 or 9 over IPv6) addressed to the process's MAC on its VPC wakes it, and so does a neighbor solicitation for its address; a wake request here or a timer does too. |
wake.mode | string (one of) | | "lan" | lan, none | lan: frames and neighbor solicitations on the VPC wake it. none: only a wake request, a timer or desiredState wake it. |
wake.maxPerHour | integer | | 60 | 1 to 3600 | At most this many wakes in any hour; more are ignored and counted. |
wake.minIntervalSeconds | integer | | 5 | 1 to 3600 | At least this many seconds between two wakes; closer ones are ignored and counted. |
wake.addresses | list of string | | | up to 8 items | Extra IPv6 addresses answered for while it sleeps (its link-local and SLAAC addresses always are); a program that picks other addresses lists them here. |
wake.requestedAt | string | | | up to 40 characters | RFC 3339 time. Set it to now to wake the process; a value newer than status.wake.lastAt wakes it. |
billing | object | | | | Platform processes only: who pays for the CPU this process uses. Set by the platform when it creates the process; it cannot be changed. |
billing.owner | object | | | | The customer's resource this process works for: its project, kind and name. Its CPU time (queries and housekeeping) is billed to that project's billing account. |
billing.owner.project | string | | | up to 63 characters | The owner's project. |
billing.owner.workspace | string | | | up to 63 characters | Another word for project (spec 0034); stored as project. |
billing.owner.kind | string | | | length 1 to 63 | The owner's kind, for example Database. |
billing.owner.name | string | | | length 1 to 63 | The owner's name. |
hibernation | object | | | | Where and when a resident process is snapshotted so that it can be hibernated, moved, or continued after a machine is lost. Requires residency Resident. |
hibernation.bucketRef | object | yes | | | The Storage bucket of this project that holds the snapshots. It is also made available to the program, like an entry of buckets. |
hibernation.bucketRef.name | string | yes | | length 1 to 63 | Name of the bucket. |
hibernation.checkpointEverySeconds | integer | | 0 | 0 to 86400 | While running, take a snapshot this often when something changed, so a lost machine costs at most this much progress. 0 (the default) takes none; otherwise 10 to 86400. |
hibernation.idleAfterSeconds | integer | | 0 | 0 to 86400 | Hibernate by itself after this many seconds without an activation, and wake on a frame, a neighbor solicitation, a timer or a request. 0 (the default) never; otherwise 30 to 86400. |
secrets | list of object | | | up to 32 items | Secrets delivered to the program inside its sandbox (spec 0039 section 11, spec 0021 'Secrets'). The values are never visible in this object, in the process's configuration, its logs or its snapshots' metadata. |
secrets[].secretRef | object | yes | | | The secret, a Secret of this project. |
secrets[].secretRef.name | string | yes | | length 1 to 63 | Name of the secret. |
secrets[].keys | list of string | | | up to 32 items | Only these keys of the secret; empty means all. |
secrets[].as | object | yes | | | How the program receives it. Only host is available: the program reads a key with the host function secret(name, key). A program is a core WebAssembly module, so there is no environment or file to put a value in. |
secrets[].as.host | object | | | | Deliver through the host function secret. |
buckets | list of object | | | up to 4 items | Storage buckets of this project the program may read and write. Nothing else is reachable. |
buckets[].name | string | yes | | length 1 to 63 | Name of the bucket. |