Virtual Machine Configuration
VirtualMachineConfiguration
A reusable configuration template for virtual machine instances.
It sets the operating system, the base startup script, and the baseline observability agents, for example logging and metrics. VirtualMachine manifests reference it by name.
| Property | Type | Description |
|---|---|---|
| apiVersion | string | API schema version. Must be lowops.manifests.v1. |
| kind | string | Resource kind. Must be VirtualMachineConfiguration. |
| metadata | map | The engine reads the reserved keys name and organization to resolve the identity. VirtualMachine manifests reference it in the dependency graph. |
| spec | VirtualMachineConfigurationDefinition | Reusable VM template: operating system, base startup script, and observability agent settings. See VirtualMachineConfigurationDefinition. |
VirtualMachineConfigurationDefinition
Core configuration of a virtual machine blueprint.
A template for VirtualMachine manifests: OS image, agent, and baseline secrets.
| Property | Type | Description |
|---|---|---|
| operatingSystem | string | Operating system of the VM. It selects the boot disk image. One of the supported Debian, Ubuntu, or Windows Server values. |
| secrets | list of SecretsEntry | Map from Secret manifest name to how the VM gets the secret, as a file or environment variable. |
| agent | AgentConfig | Ops Agent settings for the logs and metrics that the VM exports. |
| volumes | list of VolumesEntry | Map from absolute mount path in the VM, for example /data, to the volume mounted there. |
| startup | StartupConfig | Startup script and template variables of the VM. |
SecretsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | VirtualMachineSecretConfig |
AgentConfig
Ops Agent settings for a VM.
Selects the logs and metrics that go to Cloud Monitoring.
| Property | Type | Description |
|---|---|---|
| logFiles | list of string | Glob patterns of log files that the Ops Agent ships to Cloud Logging. |
| metrics | list of MetricConfig | Custom metric collectors to add to the Ops Agent. |
StartupConfig
Startup script of a VM.
Sets metadata.startup-script of the instance and substitutes template variables on boot.
| Property | Type | Description |
|---|---|---|
| script | string | Script body. The engine substitutes the variables before the script runs on boot. |
| variables | list of VariablesEntry | Map from variable name to its definition (default value and required flag). |
VolumesEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | VirtualMachineVolumeConfig |
MetricConfig
Custom metric collection for the Ops Agent.
Adds custom receivers to the Ops Agent configuration on the VM.
| Property | Type | Description |
|---|---|---|
| type | string | Receiver type. The only value is prometheus. |
| prometheus | PrometheusConfig | Prometheus scrape settings, used when type is prometheus. |
VirtualMachineSecretConfig
Secret delivery to a virtual machine.
The startup script writes each Secret Manager payload as a file or variable.
| Property | Type | Description |
|---|---|---|
| type | string | ENV_VAR sets an environment variable. FILE writes a file with the startup script. |
| target | string | For FILE, the absolute path of the file to create. For ENV_VAR, the name of the environment variable. |
VirtualMachineVolumeConfig
Storage volume for a virtual machine.
Creates a persistent disk or a bucket mount on the VM.
| Property | Type | Description |
|---|---|---|
| name | string | Logical name of the volume. VirtualMachine volume mounts refer to it. |
| type | string | BUCKET (Cloud Storage FUSE mount), DISK (persistent disk), or SECRET (Secret Manager payload). |
| fileSystem | string | Only for DISK volumes. Filesystem of the disk. It must be compatible with the VM operating system. |
| encrypted | bool | Only for DISK volumes. If true, the engine encrypts the disk. |
VariablesEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | VariableConfig |
VariableConfig
Template variable of the startup script.
The engine injects resolved variables into the script.
| Property | Type | Description |
|---|---|---|
| defaultValue | string | Value used when the VM manifest gives none. The engine substitutes it into a text/template and does not escape it. Validation rejects shell metacharacters: ;, &, ` |
| required | bool | If true, the engine returns an error when the variable has no value. |
PrometheusConfig
Prometheus receiver for the Ops Agent.
The Ops Agent scrapes the endpoint and port on the VM localhost.
| Property | Type | Description |
|---|---|---|
| scheme | string | URL scheme for the scrape: http or https. |
| endpoint | string | Metrics path on the VM localhost, for example /metrics. |
| port | int64 | Localhost port to scrape. |