Virtual Machine
VirtualMachine
Defines a managed virtual machine or a stateful VM cluster.
Provisions compute capacity from a VirtualMachineConfiguration template.
| Property | Type | Description |
|---|---|---|
| apiVersion | string | API schema version. Must be lowops.manifests.v1. |
| kind | string | Resource kind. Must be VirtualMachine. |
| metadata | map | Reserved keys such as name and project resolve the manifest identity and its parent Project. |
| spec | Spec | User-authored specification of the virtual machine. See Spec. |
BucketConfigsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | ComputedVirtualMachineBucketConfig |
DiskConfigsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | ComputedVirtualMachineDiskConfig |
Spec
User-provided virtual machine configuration.
Sets machine size, clustering, mesh strategy, health probes, autoscaling and service account access.
| Property | Type | Description |
|---|---|---|
| description | string | Optional free-text description. The engine copies it to the instance template and managed instance group descriptions. |
| machineType | string | Compute machine type, for example e2-standard-4. |
| meshStrategy | string | Service mesh integration. SIDECAR deploys a proxy sidecar. PROXYLESS uses gRPC libraries and no sidecar. DISABLED and EXCLUDED keep the VM out of the mesh and create no routing. |
| stateful | Stateful | Stateful clustering. When omitted, scaling governs the VM as a stateless autoscaled group. See Stateful. |
| configuration | Configuration | Template reference and boot-time injection. See Configuration. |
| health | Health | Health probe settings. When unset, the instance has no application health check. See Health. |
| ports | list of PortsEntry | Map of port number to protocol (for example http, grpc). Each entry creates mesh routing and backend service configuration. When empty, the engine creates no routing. |
| accessControl | ApplicationAccessControlConfig | Permissions of the VM service account over other resources, such as secrets, buckets and pub/sub. See ApplicationAccessControlConfig. |
| scaling | Scaling | Autoscaling of stateless VMs. For stateful VMs, use stateful.clusterSize. See Scaling. |
Configuration
Base configuration and runtime injection.
Selects the VirtualMachineConfiguration template and injects variables, secrets and volume mounts at boot.
| Property | Type | Description |
|---|---|---|
| source | string | Name of the VirtualMachineConfiguration that supplies the operating system and base startup script. Required. |
| variables | list of VariablesEntry | Variables for the startup script. A value overrides the defaultValue of the matching variable in the VirtualMachineConfiguration. The engine rejects shell metacharacters (;, &, ` |
| secrets | list of SecretsEntry | Map of environment-variable name to Secret manifest name, injected into the startup script. The engine also provisions the default secrets that the referenced configuration declares. |
| volumeMounts | list of VolumeMountsEntry | Map of in-VM mount path (for example /data) to volume source, combined with the volumes of the referenced VirtualMachineConfiguration. See VirtualMachineVolumeMount. |
SecretsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |
VariablesEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |
VolumeMountsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | VirtualMachineVolumeMount |
Health
Application health probes.
Startup and liveness probes for the application on the VM.
| Property | Type | Description |
|---|---|---|
| startup | HostHealthConfig | NOT YET IMPLEMENTED. The engine ignores this field. The VM health check comes from liveness. See HostHealthConfig. |
| liveness | HostHealthConfig | Health check settings of the VM. They drive the health check of the instance backend service and the auto-healing of the managed instance group. See HostHealthConfig. |
PortsEntry
| Property | Type | Description |
|---|---|---|
| key | int32 | |
| value | string |
Scaling
Autoscaling bounds for stateless VMs.
Sets the size range of the instance group autoscaler. Ignored for stateful VMs.
| Property | Type | Description |
|---|---|---|
| min | int32 | Minimum number of instances. Applied only when greater than 0. The default is 1. |
| max | int32 | Maximum number of instances. Applied only when greater than 0. The default is 10. |
Stateful
Stateful cluster topology.
Runs the VMs as a stateful managed instance group instead of a stateless autoscaled group.
| Property | Type | Description |
|---|---|---|
| enabled | bool | If true, the VMs run as a stateful managed instance group with persistent disks and stable network identities. If false, a stateless autoscaled group runs the VMs. |
| clusterSize | int32 | Number of instances in the stateful cluster. Applies only when enabled is true. For stateless VMs, use scaling.min and scaling.max. |
| allowTcp | list of int32 | NOT YET IMPLEMENTED. The engine ignores this field. Intended use: TCP ports open between the cluster instances. |
| health | HostHealthConfig | NOT YET IMPLEMENTED. The engine ignores this field. Intended use: the health probe that gates and repairs cluster members. See HostHealthConfig. |
ApplicationAccessControlConfig
All external access rules of an application.
Each block adds IAM bindings, SQL grants, or secret access.
| Property | Type | Description |
|---|---|---|
| additionalRoles | list of string | Extra IAM roles for the application service account, beyond the roles from the other blocks. |
| pubsub | ApplicationAccessControlPubsubConfig | Publish and subscribe grants for specific Pub/Sub topics. |
| buckets | list of ApplicationAccessControlBucketConfig | Cloud Storage buckets that the application can read or write. |
| database | ApplicationAccessControlDatabaseConfig | PostgreSQL database access: instance, schema, privileges, and credential source. |
| secrets | list of SecretsEntry | Map from Secret manifest name to how the application gets the secret. |
| redis | list of ApplicationAccessControlRedisConfig | Redis instances that the application can use. |
| jobs | list of ApplicationAccessControlJobConfig | Cloud Run Jobs of other applications that this application can trigger with the RunJob API. |
VirtualMachineVolumeMount
Mount of a volume in a VM application.
Sets the mount instructions (fstab entries or FUSE attachments) on the VM.
| Property | Type | Description |
|---|---|---|
| source | string | Volume source. Same as DiskSnapshotConfiguration.source. |
| mountOptions | list of string | Extra mount options. The engine joins them into the mount command. |
| diskConfig | VirtualMachineVolumeMountDiskConfig | Size, type, and snapshot settings for a DISK mount. |
ComputedVirtualMachineBucketConfig
Computed bucket mount for a VM.
Links the VM configuration to the bucket that Cloud Storage FUSE mounts.
| Property | Type | Description |
|---|---|---|
| source | string | Resolved bucket to mount. It comes from the volume name in the VirtualMachineConfiguration manifest. |
| mountOptions | string | FUSE mount option string. The engine computes it from the VM operating system. |
HostHealthConfig
Health check for host endpoints.
Sets the probes and backend health checks for GCP load balancers.
| Property | Type | Description |
|---|---|---|
| protocol | string | Health check protocol: http, http2, https, grpc, or tcp. It applies to container probes (Cloud Run, GKE) and the VM backend health check. |
| port | int64 | TCP port that the health check targets. |
| checkIntervalSec | int64 | Interval between checks, in seconds. The default is 30 for generated probes. Default 30 |
| timeoutSec | int64 | Seconds to wait for a probe response before it fails. The engine sets 10 for generated probes. Default 5 |
| healthyThreshold | int64 | Consecutive successful probes that mark the endpoint healthy. The default is 1. Default 1 |
| unhealthyThreshold | int64 | Consecutive failed probes that mark the endpoint unhealthy. The default is 2. Default 2 |
| enableLogs | bool | NOT YET IMPLEMENTED. The engine ignores this field. Intended to enable health-check logs. |
| path | string | HTTP request path for HTTP-family probes. The default is /. Default "/" |
ComputedVirtualMachineDiskConfig
Computed specification of a VM attached disk.
Combines size, snapshot, and filesystem details.
| Property | Type | Description |
|---|---|---|
| name | string | Resolved disk name, from the volume name in the VirtualMachineConfiguration manifest. |
| fileSystem | string | Disk filesystem, from the volume fileSystem in the VirtualMachineConfiguration manifest. |
| mountOptions | string | Disk mount option string. The engine computes it from the filesystem and VM operating system. |
| sourceSnapshot | string | Source snapshot, from the volume mount sourceSnapshot in the VirtualMachine manifest. |
| encrypted | bool | Disk encryption flag, from the volume encrypted in the VirtualMachineConfiguration manifest. |
| diskSizeGb | int64 | Disk size, in GB, from the volume mount diskSizeGb in the VirtualMachine manifest. |
| diskType | string | Compute Engine disk type, from the volume mount diskType in the VirtualMachine manifest. |
SecretsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | SecretSourceConfig |
ApplicationAccessControlRedisConfig
Redis cache access for a workload.
Injects the connection URL as an environment variable. All instances use TLS (SERVER_AUTHENTICATION).
| Property | Type | Description |
|---|---|---|
| name | string | Name of the Redis manifest. The application deploys after the DNS record of the instance resolves. Required. |
| envVar | string | Environment variable that receives the connection URL redis[s]://memory-<redis-name>.<internal-domain>:<port>. Meshed strategies (SIDECAR, PROXYLESS) use redis:// on port 6380. Direct access (DISABLED) uses rediss:// on port 6379. Required. |
| caCertPath | string | Absolute path in the container of the server CA certificate (PEM). The application must load it into its TLS trust pool. Required. |
VirtualMachineVolumeMountDiskConfig
Specification of an attached disk volume.
Sets the size and type of the disk behind the mount.
| Property | Type | Description |
|---|---|---|
| sizeGb | int64 | Disk size, in GB. Only for DISK volumes. The minimum is 200 GB. |
| type | string | Compute Engine disk type, for example pd-ssd. Only for DISK volumes. |
| snapshots | list of DiskSnapshotConfiguration | Optional snapshot configurations that seed the disk in specific environments. |
ApplicationAccessControlDatabaseConfig
PostgreSQL access for a workload.
Runs CREATE USER and GRANT on the target SQL instance.
| Property | Type | Description |
|---|---|---|
| name | string | Name of the Database manifest (an AlloyDB/PostgreSQL instance) that the application needs. |
| schema | string | Database (schema) in the instance that the application connects to. |
| privileges | list of string | SQL privileges for the application database role on the schema: USAGE, CREATE, or ALL. Each one becomes a GRANT statement. |
| readOnly | bool | If true, the application has read-only access, typically to a read replica. |
| extensions | list of string | PostgreSQL extensions to enable. Each entry runs CREATE EXTENSION IF NOT EXISTS. The engine merges the lists of all applications that share a schema. |
| secretSource | SecretSourceConfig | Source of the database credentials: the Secret manifest and how the application gets it (environment variable or file mount). Required. |
ApplicationAccessControlBucketConfig
Cloud Storage access for a workload.
Grants roles/storage.objectViewer or roles/storage.objectUser on a bucket.
| Property | Type | Description |
|---|---|---|
| name | string | Name of the Bucket manifest. It must exist in every environment of the parent ReleaseTrack. Required. |
| source | string | Name of a GithubRepository manifest whose contents seed the bucket through a gcloud storage rsync job in CI/CD. Optional. |
| permission | string | READ_ONLY grants roles/storage.objectViewer. WRITE grants roles/storage.objectUser. |
| mountPath | string | Absolute path in the container where Cloud Storage FUSE mounts the bucket. If omitted, the engine grants access but does not mount the bucket. |
| subPath | string | Bucket prefix that limits access, for example to mount one folder. If omitted, access covers the whole bucket. |
| promote | bool | If true, the engine promotes the bucket content through the ReleaseTrack with the application. |
| envVar | string | Environment variable that receives the bucket name, instead of a filesystem mount. Mutually exclusive with mount_path. |
ApplicationAccessControlPubsubConfig
Pub/Sub permissions for a workload.
The engine grants the roles to the service account of the workload.
| Property | Type | Description |
|---|---|---|
| publishTo | list of string | Names of PubSub manifests that the workload can publish to. Each entry grants roles/pubsub.publisher on the topic. |
| subscribeTo | list of string | Each entry, a PubSub manifest name, grants roles/pubsub.subscriber on the TOPIC. On a topic, this role only gives pubsub.topics.attachSubscription. The workload can attach a subscription, but it cannot pull from or acknowledge on any subscription, even a managed one in spec.subscriptions. To create a subscription, the workload also needs pubsub.subscriptions.create on the project, which this field does not grant. To consume from a managed subscription, use pull_from. The behavior stays unchanged for old manifests. |
| pullFrom | list of ApplicationAccessControlPubsubPullConfig | Each entry grants roles/pubsub.subscriber on one subscription from spec.subscriptions of a PubSub manifest, and nothing on the topic or the project. The topic and subscription must exist in the project of the workload, or validation fails. See ApplicationAccessControlPubsubPullConfig. |
ApplicationAccessControlJobConfig
Permission to trigger a Cloud Run Job of another application.
Grants roles/run.developer on the job and injects the job resource name as an environment variable.
| Property | Type | Description |
|---|---|---|
| application | string | Name of the Application manifest that owns the target job. Required. |
| job | string | Name of the job. It matches an ApplicationJobReference.name of that application. Required. |
| envVar | string | Environment variable for the full Cloud Run resource name of the job. If empty, the caller must derive the job name. |
ApplicationAccessControlPubsubPullConfig
Pub/Sub subscription that a workload consumes.
Grants roles/pubsub.subscriber on a subscription or its dead-letter subscription.
| Property | Type | Description |
|---|---|---|
| topic | string | Name of the PubSub manifest (topic) that declares the subscription. Required. |
| subscription | string | Name of the subscription in spec.subscriptions of that manifest. Required. |
| deadLetter | bool | If true, the grant targets the dead-letter subscription <topic>-<subscription>-dlq-sub. The subscription must declare deadLetter. To republish messages, the worker also needs the topic in publish_to. |
DiskSnapshotConfiguration
Source snapshot for an environment.
The snapshot link for a new compute disk of a VM.
| Property | Type | Description |
|---|---|---|
| source | string | For a BUCKET volume, the bucket name to mount. For a DISK volume, an optional Compute snapshot self-link. |
| mountOptions | list of string | Extra mount options, for example FUSE or fstab flags. |
| diskConfig | DiskSnapshotDiskConfig | Size, type, and per-environment snapshot sources for a DISK volume. |
SecretSourceConfig
How to retrieve a secret and mount it into a workload.
The engine grants IAM access to the Secret Manager payload and resolves values JIT.
| Property | Type | Description |
|---|---|---|
| envVar | string | Name of the environment variable that holds the secret. Mutually exclusive with file_path: set exactly one. |
| version | string | Secret Manager version: latest or a number such as 1. Defaults to latest. |
DiskSnapshotDiskConfig
Properties of a disk created from a snapshot.
Sets the size and type of the disk.
| Property | Type | Description |
|---|---|---|
| sizeGb | int64 | Disk size, in GB. Only for DISK volumes. |
| type | string | Compute Engine disk type, for example pd-ssd. Only for DISK volumes. |
| snapshots | list of SnapshotsEntry | Map from environment name to the source snapshot self-link in that environment. |
SnapshotsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |