Skip to main content

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.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be VirtualMachineConfiguration.
metadatamapThe engine reads the reserved keys name and organization to resolve the identity. VirtualMachine manifests reference it in the dependency graph.
specVirtualMachineConfigurationDefinitionReusable 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.

PropertyTypeDescription
operatingSystemstringOperating system of the VM. It selects the boot disk image. One of the supported Debian, Ubuntu, or Windows Server values.
secretslist of SecretsEntryMap from Secret manifest name to how the VM gets the secret, as a file or environment variable.
agentAgentConfigOps Agent settings for the logs and metrics that the VM exports.
volumeslist of VolumesEntryMap from absolute mount path in the VM, for example /data, to the volume mounted there.
startupStartupConfigStartup script and template variables of the VM.

SecretsEntry​

PropertyTypeDescription
keystring
valueVirtualMachineSecretConfig

AgentConfig​

Ops Agent settings for a VM.

Selects the logs and metrics that go to Cloud Monitoring.

PropertyTypeDescription
logFileslist of stringGlob patterns of log files that the Ops Agent ships to Cloud Logging.
metricslist of MetricConfigCustom 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.

PropertyTypeDescription
scriptstringScript body. The engine substitutes the variables before the script runs on boot.
variableslist of VariablesEntryMap from variable name to its definition (default value and required flag).

VolumesEntry​

PropertyTypeDescription
keystring
valueVirtualMachineVolumeConfig

MetricConfig​

Custom metric collection for the Ops Agent.

Adds custom receivers to the Ops Agent configuration on the VM.

PropertyTypeDescription
typestringReceiver type. The only value is prometheus.
prometheusPrometheusConfigPrometheus 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.

PropertyTypeDescription
typestringENV_VAR sets an environment variable. FILE writes a file with the startup script.
targetstringFor 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.

PropertyTypeDescription
namestringLogical name of the volume. VirtualMachine volume mounts refer to it.
typestringBUCKET (Cloud Storage FUSE mount), DISK (persistent disk), or SECRET (Secret Manager payload).
fileSystemstringOnly for DISK volumes. Filesystem of the disk. It must be compatible with the VM operating system.
encryptedboolOnly for DISK volumes. If true, the engine encrypts the disk.

VariablesEntry​

PropertyTypeDescription
keystring
valueVariableConfig

VariableConfig​

Template variable of the startup script.

The engine injects resolved variables into the script.

PropertyTypeDescription
defaultValuestringValue used when the VM manifest gives none. The engine substitutes it into a text/template and does not escape it. Validation rejects shell metacharacters: ;, &, `
requiredboolIf 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.

PropertyTypeDescription
schemestringURL scheme for the scrape: http or https.
endpointstringMetrics path on the VM localhost, for example /metrics.
portint64Localhost port to scrape.