Skip to main content
This reference documents the YAML manifests accepted for IDYL workloads. The pages are generated from the YAML-tagged types in github.com/idyl-labs/core/resource.

Manifest shape

Every workload manifest has the same top-level structure:
kind: Deployment
metadata:
  name: web
  subnet: <subnet>
spec:
  # resource-specific desired state

Workload manifests

WorkloadKindDescription
DeploymentDeploymentA Deployment keeps a replicated pod template running and can roll changes across replicas.
PodPodA Pod runs one or more containers as a single scheduled workload.
ReplicaSetReplicaSetA ReplicaSet keeps a fixed number of pods running from one pod template.
JobJobA Job runs a pod template until the requested completions succeed.
CronJobCronJobA CronJob creates Jobs on a schedule.
SandboxSandboxA Sandbox runs a temporary pod template until its TTL expires.

Scope resolution

For CLI-created resources, account, namespace, and subnet can come from the manifest, command flags, or the active CLI context. Command flags have the highest priority.
Scope valueManifest pathOverride flag
Accountmetadata.namespace.accountId--account-id
Namespacemetadata.namespace.namespace--namespace
Subnetmetadata.subnet--subnet

Quantity formats

QuantityAccepted format
CPUWhole vCPU (1), decimal vCPU (0.5), or millicores (500m). Decimal CPU supports up to three fractional digits.
Memory and diskBinary units (Ki, Mi, Gi, Ti), decimal units (B, K, M, G, T), or a bare byte count.
GPUCount (4), model (h100), count and model (2:h100), model and memory (a100:80Gi), or family and memory (nvidia:24Gi).

Read-only fields

IDYL can return these fields when you inspect a workload. Do not include them in authored manifests.
FieldDescription
metadata.idIDYL-assigned resource ID.
metadata.namespace.idIDYL-assigned namespace ID.
metadata.subnetSlugResolved subnet slug returned by IDYL.
metadata.ownerReferencesParent workload relationship, such as a ReplicaSet owned by a Deployment.
metadata.createdAtCreation timestamp.
metadata.updatedAtLast update timestamp.
metadata.deletedAtDeletion timestamp, when present.
metadata.revisionRevision information returned by IDYL.
statusCurrent observed state returned by IDYL.