Skip to main content
API resource reference for Instance, part of the Compute service. To create or change one, see Changing resources; to inspect, see Reading resources.
This resource is part of the v1alpha API and is subject to change. Fields and behavior may change in future releases.

Identity

Groupcompute.datumapis.com
Versionv1alpha
KindInstance
ScopeProject

Overview

An Instance represents a single compute workload running in a Datum Cloud Project. Each instance runs one of two runtime types: a sandbox (a managed, isolated environment for running one or more containers) or a virtual machine (a classical VM booting a full OS from a user-provided image). Every instance attaches to one or more networks through its network interfaces and may mount volumes backed by disks, config maps, or secrets. Use an Instance when you need to run application code — as containers or as a full VM — with a defined instance type, network connectivity, and optional persistent storage inside a Project.

Spec fields

FieldTypeRequiredDescription
spec.runtimeObjectYesThe runtime type of the instance, such as a container sandbox or a VM.
spec.runtime.resourcesObjectYesResources each instance must be allocated across its containers or VM.
spec.runtime.resources.instanceTypestringYesFull or partial URL of the instance type resource to use (for example, datumcloud/d1-standard-2).
spec.runtime.resources.requestsmap[string]ObjectNoAdjustments to the resources defined by the instance type (for customizable instance families).
spec.runtime.sandboxObjectNoA managed isolated environment capable of running containers.
spec.runtime.sandbox.containers[]ObjectYes (if sandbox)The containers to run within the sandbox; each requires a name and image.
spec.runtime.sandbox.imagePullSecrets[]ObjectNoSecrets in the same Project used for pulling images.
spec.runtime.virtualMachineObjectNoA classical VM environment booting a full OS from a user-provided image.
spec.runtime.virtualMachine.volumeAttachments[]ObjectYes (if VM)Volumes to attach to the VM.
spec.runtime.virtualMachine.ports[]ObjectNoNamed ports for the virtual machine.
spec.networkInterfaces[]ObjectYesNetwork interface configuration for the instance.
spec.networkInterfaces[].networkObjectYesThe network to attach the interface to; network.name is required.
spec.networkInterfaces[].networkPolicyObjectNoAn interface-specific, platform-managed network policy targeting this interface.
spec.volumes[]ObjectNoVolumes available to attach to the instance’s containers or VM.
spec.volumes[].namestringYes (per volume)Name used to reference the volume in container/VM volume attachments.
spec.volumes[].diskObjectNoA persistent disk backed volume.
spec.volumes[].configMapObjectNoA config map that populates this volume.
spec.volumes[].secretObjectNoA secret that populates this volume.
spec.locationObjectNoThe location the instance has been scheduled to (name and namespace).
spec.controllerObjectNoSettings driven by the controller managing the instance, including templateHash and schedulingGates.

Status fields (read-only)

FieldTypeDescription
status.conditions[]ObjectObservations of the instance’s current state; known types are Available and Progressing.
status.controllerObjectController status, including the observedTemplateHash last applied to this instance.
status.networkInterfaces[]ObjectNetwork interface information, including address assignments.

Usage

apiVersion: compute.datumapis.com/v1alpha
kind: Instance
metadata:
  name: web-server
spec:
  runtime:
    resources:
      instanceType: datumcloud/d1-standard-2
    sandbox:
      containers:
        - name: web
          image: nginx:1.27
  networkInterfaces:
    - network:
        name: default
datumctl apply -f instance.yaml --project my-project
datumctl get instances --project my-project
datumctl describe instance web-server --project my-project
Run datumctl explain instances --recursive to see the full, live field tree for this resource.
Last modified on July 2, 2026