virtualmachine.gdc.goog/v1
Contains API Schema definitions for the virtualmachine.gdc.goog v1 API group.
AccessManagementConfig
Specifies the AccessManagement feature configuration in the guest environment.
Appears in: - GuestEnvironment
| Field | Description |
|---|---|
enable boolean |
Specifies whether to enable the AccessManagement feature in the VM's guest environment. See the GuestEnvironment field description for information about the default value of the field. |
Compute
Specifies the CPU and memory attributes of a VM.
You must specify either vcpus and memory exclusively, or specify only
VirtualMachineType.
Specifying vcpus without memory, or vice versa, creates an invalid
combination.
Specifying virtualMachineType while specifying either vcpus or memory, or
both also creates an invalid combination.
Appears in: - VirtualMachineSpec
| Field | Description |
|---|---|
virtualMachineType string |
Specifies the name of the referenced VirtualMachineType. The reference requires a predefined, or golden VirtualMachineType name. |
vcpus integer |
Specifies the number of VCPUs that are available to the instance. Specify vcpus as an integer. This value must be a multiple of 2, with 2 as the minimum and 128 as the maximum allowed. |
memory Quantity |
Specifies the amount of physical memory available to the instance. memory must have a minimum value of 1Gi, and can be up to (including) 400Gi. |
DiskAttachment
Represents the attachment relationship between the VirtualMachine and the
VirtualMachineDisk.
Appears in: - VirtualMachineSpec
| Field | Description |
|---|---|
boot boolean |
Specifies whether this disk is the boot device for the VirtualMachine. There must be exactly one disk marked as boot. |
autoDelete boolean |
Specifies whether the disk should be deleted when the VirtualMachine is deleted. AutoDelete only applies while a disk is attached to a VirtualMachine. A VirtualMachineDisk lifecycle is decoupled from the VirtualMachine once it is no longer referenced in .spec.disks. |
virtualMachineDiskRef LocalObjectReference |
Refers to a VirtualMachineDisk in the same namespace. |
DiskReplicationStatus
Appears in: - VirtualMachineDiskStatus
| Field | Description |
|---|---|
role ReplicationRole |
The role that this disk has in the replication relationship. Valid values are "primary" and "secondary". |
primaryDisk ReplicatedDiskInfo |
The primary disk that this disk is being replicated from, if this disk is a secondary disk. Will be nil for primary disks. |
secondaryDisk ReplicatedDiskInfo |
The secondary disk that this disk is being replicated to, if this disk is a primary disk. Will be nil for secondary disks. |
volumeReplicationRelationship string |
The name of the volume replication relationship object that is managing the replication. |
conditions Condition array |
The latest observations of the replications state. |
errorStatus ErrorStatus |
A list of any errors that occurred during replication. |
DiskSource
Defines the source for the disk. Specify exactly one of the supported sources to use to populate a disk.
Appears in: - VirtualMachineDiskSpec
| Field | Description |
|---|---|
image ImageDiskSource |
Denotes that the disk is created from a disk Image. |
FilterSpec
Defines the fine-grained restore Filter.
Appears in: - VirtualMachineRestoreRequestSpec
| Field | Description |
|---|---|
targetedVirtualMachines VirtualMachineResourceConfig array |
The set of VMs that needs to be restored. These VMs should be the ones that are part of the VirtualMachineBackup resource that is provided in the same VirtualMachineRestoreRequest. |
targetedVirtualMachineDisks VirtualMachineResourceConfig array |
The set of VMDisks that needs to be restored. These VMDisks should be the ones that are part of the VirtualMachineBackup resource that is provided in the same VirtualMachineRestoreRequest. |
virtualMachineDiskOptions VirtualMachineDiskFilterOptions |
Specifies the filter options for restoring disks. Specifying this field will not restore VirtualMachines, it will only restore VirtualMachineDisks based on selected field in VirtualMachineDiskFilterOptions. This field shouldn't be specified if one of TargetedVirtualMachines or TargetedVirtualMachineDisks is specified. |
Firmware
Specifies the VM initialization options at boot time.
Appears in: - VirtualMachineSpec
| Field | Description |
|---|---|
type string |
Specifies whether to boot via UEFI or BIOS. Defaults to bios. Deprecated: Use ShieldConfig.BootType instead. |
enableSecureBoot boolean |
Enables or disables boot loader certificate verification. This is to assist in blocking modified or malicious code from loading. The default value is true if type is uefi. If type is set to bios, the default value is false and cannot be modified since boot loader certificate verification is not available for BIOS. Deprecated: Use ShieldConfig.EnableSecureBoot instead. |
GCSReference
Represents the GCS source from which to store the image.
Appears in: - VirtualMachineImageSpec
| Field | Description |
|---|---|
url string |
The URL of the GCS object. |
GuestEnvironment
Specifies the guest environment configuration.
Appears in: - VirtualMachineSpec
| Field | Description |
|---|---|
accessManagement AccessManagementConfig |
Specifies the access management configuration. |
IPAddress
Appears in: - NetworkInterfaceSpec
| Field | Description |
|---|---|
address string |
The IP address. In GDC connected, the address may contain a subnet mask. If subnet mask is not included, /32 is taken as default. For example, 1.2.3.4 will be taken as 1.2.3.4/32. Alternatively, the input can be 1.2.3.4/24. In GDC airgapped, the address may not contain a subnet mask. Subnet information is retrieved from the Subnet object. |
managed boolean |
Whether the lifecycle of the Subnet associated with this IP address should be managed by the system in GDC airgapped. Unused in GDC connected. If true (default), a Subnet is created automatically for this IP and deleted during VM deletion. If false, the user must have created a Subnet and the Subnet must be in ready status. |
ImageDestinationReference
Points to the destination to which the image contents are uploaded.
Only one destination can be specified.
Only supported in GDC Connected deployments.
This field is required if the specified ImageSourceReference is GCS.
Appears in: - VirtualMachineImageImportSpec
| Field | Description |
|---|---|
gcs ImageGCSDestinationReference |
The bucket details for an image that is populated to gcs. |
ImageDiskSource
Reference to the Image Source.
Appears in: - DiskSource
| Field | Description |
|---|---|
name string |
The name of the VirtualMachineImage API object. |
namespace string |
The namespace of the VirtualMachineImage API object. For golden images use vm-system. For images in the current project, set this as empty or use the current namespace value. |
ImageGCSDestinationReference
Represents the GCS destination to which to import an image.
Appears in: - ImageDestinationReference
| Field | Description |
|---|---|
bucketName string |
The GCS Bucket name that holds this image. |
ImageGCSSourceReference
Represents the GCS source from which to import an image.
Appears in: - ImageSourceReference
| Field | Description |
|---|---|
bucketName string |
The GCS Bucket name that holds this image. |
objectName string |
The name of the image within the bucket. |
ImageMetadataInput
The specification for the VirtualMachineImage.
Appears in: - VirtualMachineImageImportSpec
| Field | Description |
|---|---|
name string |
The image name, such as ubuntu-20.04-server-cloudimg. |
operatingSystem OSName |
The name of the OS to which this image belongs, such as ubuntu-2004. |
minimumDiskSize Quantity |
The minimum size of the disk to which the image can be applied. This specifies only the recommended size for future disks that are created from this image. It does not represent the size of the image itself. This field is required if the image is being imported from object storage. |
ImageObjectStorageSourceReference
Represents the object storage source from which to import an image.
Appears in: - ImageSourceReference
| Field | Description |
|---|---|
bucketRef LocalObjectReference |
The name of the Bucket custom resource that holds this image. The Bucket custom resource must be in the same namespace as this object. |
objectName string |
The name of the image within the bucket. |
ImagePrepareOptions
Represents the options for image preparation.
Appears in: - VirtualMachineImageImportSpec
| Field | Description |
|---|---|
installGuestEnvironment boolean |
Specifies whether to install the GDC air-gapped guest environment. Defaults to true. |
ImageSourceReference
Points to the resource from which the image contents are populated. Only one source can be specified.
Appears in: - VirtualMachineImageImportSpec
| Field | Description |
|---|---|
diskRef LocalObjectReference |
Specified when the image is populated from an existing VirtualMachineDisk. |
objectStorage ImageObjectStorageSourceReference |
The bucket details for an image that is populated from object storage. |
gcs ImageGCSSourceReference |
The bucket details for an image that is populated from gcs. |
NetworkInterfaceSpec
Specifies the network interface configuration. In GDC connected, only Network and IPAddresses can be specified. In GDC airgapped, one of Network, Subnet, or IPAddresses must be specified. Subnet and IPAddresses can optionally be specified together.
Appears in: - NetworkSpec
| Field | Description |
|---|---|
network string |
The network that the interface is connected to. In GDC airgapped, valid values are: default, multicast. |
subnet string |
The subnet that the interface is connected to in GDC airgapped. Unused in GDC connected. If unspecified, defaults to the default subnet of the specified network. |
subnetNamespace string |
The namespace that the Subnet the interface is connected to in GDC airgapped. Unused in GDC connected. If unspecified, defaults to the same namespace as the VirtualMachine. |
ipAddresses IPAddress array |
The IP address to be assigned to the interface. Only the first IP address is assigned to the interface. In GDC airgapped, an IP address will be dynamically allocated if unspecified. In GDC connected, if the network is configured to use an external DHCP server, this field can optionally be used to specify a static address. If the network is not configured to use an external DHCP server, this field is required. |
NetworkInterfaceStatus
NetworkInterfaceStatus is the status for the NetworkInterface resource.
Appears in: - NetworkStatus
| Field | Description |
|---|---|
name string |
Name denotes the name of the network interface exposed inside the VM, e.g. "eth0", "eth1". |
ipAddresses string array |
IpAddresses are the IP addresses assigned to the NetworkInterface. |
macAddress string |
MacAddress is the MAC address assigned to the NetworkInterface. |
NetworkPerformanceSpec
Appears in: - NetworkSpec
| Field | Description |
|---|---|
highThroughputMode boolean |
Whether high-throughput optimization is enabled for all interfaces in the VM in GDC airgapped. Unused in GDC connected. If true, this uses features such as multiqueue to improve network performance. Defaults to false. |
NetworkSpec
Specifies the network configuration.
Appears in: - VirtualMachineSpec
| Field | Description |
|---|---|
interfaces NetworkInterfaceSpec array |
The network interfaces attached to the VM. If no unicast interfaces are specified, a default interface is automatically added. Users in a multicast-enabled organization can add the multicast interface. The first interface specified will be treated as the default interface when setting up the default route inside the VM. |
performanceSpec NetworkPerformanceSpec |
Specifies the configuration for high performance networking. |
NetworkStatus
NetworkStatus is the status for the network of the Virtual Machine.
Appears in: - VirtualMachineStatus
| Field | Description |
|---|---|
interfaces NetworkInterfaceStatus array |
OSName
Underlying type: string
The list of valid OSes for use.
Appears in: - ImageMetadataInput - OperatingSystemSpec
OperatingSystemSpec
Contains the operating system information of an image.
Appears in: - VirtualMachineImageSpec
| Field | Description |
|---|---|
name OSName |
The name of the OS to which this image belongs, e.g. "windows-2016". |
ReplicatedDiskInfo
Appears in: - DiskReplicationStatus
| Field | Description |
|---|---|
name string |
The name of the VirtualMachineDisk instance. |
zone string |
The zone of the VirtualMachineDisk instance. |
SSHSpec
Stores the ssh credentials used to establish the connection.
Appears in: - VirtualMachineAccessRequestSpec
| Field | Description |
|---|---|
key string |
Specifies the public key to program for SSH access. |
ttl Duration |
Specifies the length of time for which this key is valid, expressed in hours, minutes and seconds. The default value is 24h0m0s. |
ServicePort
ServicePort contains information on service's port.
Appears in: - VirtualMachineExternalAccessSpec
| Field | Description |
|---|---|
name string |
The name of this port within the service. |
protocol Protocol |
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". |
port integer |
The port that will be exposed by this service. |
ShieldConfig
Specifies the VM's security-related configurations.
Appears in: - VirtualMachineSpec
| Field | Description |
|---|---|
bootType string |
Specifies whether to boot via UEFI or BIOS. Defaults to bios. |
enableSecureBoot boolean |
Enables or disables boot loader certificate verification. This is to assist in blocking modified or malicious code from loading. The default value is true if bootType is uefi. If bootType is set to bios, the default value is false and cannot be modified since boot loader certificate verification is not available for BIOS. |
enableVtpm boolean |
Whether to emulate a VTPM device. Defaults to false. |
StartupScript
Defines a startup script for a VM.
Supports the specification of a startup script either as a plain text string
or a Kubernetes secret. If the field script is specified, then the field
scriptSecretRef should not be provided, and vice versa.
Appears in: - VirtualMachineSpec
| Field | Description |
|---|---|
name string |
Specifies the name of a script. Must match the regex [\w][\w\-.]* and be at most 255 characters. If specifying a script for a Windows VM, the name must include a '-' followed by the script extension as a suffix. For example, use the name hello-world-ps1 for a Powershell script named hello-world. |
script string |
Specifies a plain text string that contains the script. The script content size must be lesser than 2048 bytes. |
scriptSecretRef LocalObjectReference |
References a Kubernetes secret that contains the script. The ScriptSecretRef name must match the name of the Kubernetes secret. |
VMMError
Wrapper for all VMM errors, including error codes.
Appears in: - VirtualMachineAccessRequestStatus - VirtualMachineDiskStatus - VirtualMachineExternalAccessStatus - VirtualMachineImageImportStatus - VirtualMachineImageStatus - VirtualMachinePasswordResetRequestStatus - VirtualMachineStatus
| Field | Description |
|---|---|
code string |
The code for the error. It includes a prefix with letters followed by a four-digit numeric code. |
message string |
The human-readable error message. |
VirtualMachine
Represents the Virtual Machine's configuration and state.
Appears in: - VirtualMachineList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachine |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineSpec |
|
status VirtualMachineStatus |
VirtualMachineAccessRequest
Represents an access request to a VM.
Appears in: - VirtualMachineAccessRequestList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineAccessRequest |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineAccessRequestSpec |
|
status VirtualMachineAccessRequestStatus |
VirtualMachineAccessRequestList
Contains a list of VirtualMachineAccessRequest objects.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineAccessRequestList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineAccessRequest array |
VirtualMachineAccessRequestSpec
Defines the VirtualMachineAccessRequest specification.
Appears in: - VirtualMachineAccessRequest
| Field | Description |
|---|---|
vm string |
Specifies the name of the VM to access. |
user string |
Specifies the username for accessing the VM. |
ssh SSHSpec |
Holds the ssh credentials used to access the VM. |
VirtualMachineAccessRequestState
Underlying type: string
State of VirtualMachineAccessRequest.
Appears in: - VirtualMachineAccessRequestStatus
VirtualMachineAccessRequestStatus
Describes the status of the VirtualMachineAccessRequest.
Appears in: - VirtualMachineAccessRequest
| Field | Description |
|---|---|
state VirtualMachineAccessRequestState |
Specifies the state of VirtualMachineAccessRequest. |
reason string |
Indicates the reason for the current status. |
message string |
Provides additional context for the current status. |
processedAt Time |
Specifies the time when the request was processed. |
errors VMMError array |
A list of any errors that occurred during the reconciliation of this resource. |
VirtualMachineAttachment
Contains information about which VirtualMachine this VirtualMachineDisk is
attached to, and how it is attached.
Appears in: - VirtualMachineDiskStatus
| Field | Description |
|---|---|
nameRef LocalObjectReference |
The name of an attached VirtualMachine. |
uid UID |
The UID of the attached VirtualMachine. |
autoDelete boolean |
Reflective of how the VirtualMachine attaches this disk. The disk is deleted when all VMs attached have autoDelete set to true and all VMs are deleted. If a minimum of one VM has autoDelete set to false, the disk will not be deleted. |
VirtualMachineBackup
The Schema for the VirtualMachineBackups API.
Appears in: - VirtualMachineBackupList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineBackup |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineBackupSpec |
|
status VirtualMachineBackupStatus |
VirtualMachineBackupConfig
Contains configuration details for executing the backup, including scope, location, and volume backup strategy.
Appears in: - VirtualMachineBackupPlanSpec - VirtualMachineBackupSpec
| Field | Description |
|---|---|
backupRepository string |
Identifies the secondary storage location for this VirtualMachineBackupPlan. This field is meant for internal use only. Provide Backup repository only through VirtualMachineBackupPlanTemplate |
backupScope VirtualMachineBackupScope |
Specifies the resource(s) covered by this VirtualMachineBackupPlan. |
volumeStrategy VolumeStrategy |
Declares the strategy to use for backing-up volumes; for example, use a local snapshot vs. using remote or provisioner-specific backup. |
VirtualMachineBackupList
Contains a list of VirtualMachineBackup.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineBackupList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineBackup array |
VirtualMachineBackupPlan
The Schema for the VirtualMachineBackupPlans API.
Appears in: - VirtualMachineBackupPlanList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineBackupPlan |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineBackupPlanSpec |
|
status VirtualMachineBackupPlanStatus |
VirtualMachineBackupPlanList
Contains a list of VirtualMachineBackupPlan.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineBackupPlanList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineBackupPlan array |
VirtualMachineBackupPlanSpec
Defines a VirtualMachineBackupPlan which provides instructions for creating an
underlying BackupPlan resource and ProtectedApplication to perform backups.
Appears in: - VirtualMachineBackupPlan
| Field | Description |
|---|---|
virtualMachineBackupPlanTemplate string |
The VirtualMachineBackupPlanTemplate must live in the same namespace as this vm backup plan. |
backupConfig VirtualMachineBackupConfig |
Defines the configuration and scope of the backup. |
backupSchedule Schedule |
The scheduled backup creation under this VM backup plan. Schedule is a mutable field which can be edited after creation By default, VM backup plan will be paused |
retentionPolicy RetentionPolicy |
The lifecycle of backups created under this plan. by default, backups can be deleted without any locking period by default, backups are not deleted by automatic schedule and retention policy can be modified |
VirtualMachineBackupPlanStatus
Defines the observed state of VirtualMachineBackupPlan.
Appears in: - VirtualMachineBackupPlan
| Field | Description |
|---|---|
backupPlan string |
The name of the underlying backup plan managed by this VirtualMachineBackupPlan, used in GDC air-gapped Org v1 Architecture. |
backupPlanStatus BackupPlanStatus |
The embedded status of the underlying backup plan. |
configBackupPlan string |
The name of the underlying config backup plan managed by this VirtualMachineBackupPlan. Config here refers to VM and VM Disk, used in GDC air-gapped Org v2 Architecture. |
volumeBackupPlan string |
The name of the underlying volume backup plan managed by this VirtualMachineBackupPlan, used in GDC air-gapped Org v2 Architecture. |
lastBackupTime Time |
The timestamp for the most recently executed backup. This field is used to schedule next backup |
nextBackupTime Time |
The timestamp for the next scheduled backup. This field is used to schedule next backup |
lastReconcileTime Time |
The timestamp of last reconciliation of this resource. |
errorMessage string |
ErrorMessage holds the error message that occurred during the last reconciliation attempt. This field is optional and will only be populated if an error occurred. |
VirtualMachineBackupPlanTemplate
The VirtualMachineBackupPlanTemplates API schema.
Appears in: - VirtualMachineBackupPlanTemplateList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineBackupPlanTemplate |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineBackupPlanTemplateSpec |
|
status VirtualMachineBackupPlanTemplateStatus |
VirtualMachineBackupPlanTemplateList
Contains a list of VirtualMachineBackupPlanTemplate.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineBackupPlanTemplateList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineBackupPlanTemplate array |
VirtualMachineBackupPlanTemplateSpec
Defines the template that the VirtualMachineBackupPlans use for deriving common parameters.
Appears in: - VirtualMachineBackupPlanTemplate
| Field | Description |
|---|---|
backupRepository string |
The name of a BackupRepository resource. |
VirtualMachineBackupRequest
The Schema for the VirtualMachineBackupRequests API.
Appears in: - VirtualMachineBackupRequestList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineBackupRequest |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineBackupRequestSpec |
|
status VirtualMachineBackupRequestStatus |
VirtualMachineBackupRequestList
Contains a list of VirtualMachineBackupRequest.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineBackupRequestList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineBackupRequest array |
VirtualMachineBackupRequestSpec
Defines the desired state of VirtualMachineBackupRequest.
Appears in: - VirtualMachineBackupRequest
| Field | Description |
|---|---|
virtualMachineBackupPlanTemplate string |
The name of the VirtualMachineBackupPlanTemplate resource used to generate a VirtualMachineBackupPlan. Re-uses the pre-existing VirtualMachineBackupPlan made from this template, if there is one. The VirtualMachineBackupPlanTemplate must live in the same namespace as this request. Specify only one of either VirtualMachineBackupPlanTemplate OR VirtualMachineBackupPlan. |
virtualMachineBackupPlan string |
The virtual machine backup plan which this request uses for adhoc request with backup scope VirtualMachine and VirtualMachineDisk fields should be omitted when this field is provided The VirtualMachineBackupPlan must live in the same namespace as this request. |
virtualMachine string |
The VirtualMachine that is being backed up. This is used with the VirtualMachineBackupPlanTemplate to automatically generate a VirtualMachineBackupPlan if one does not exist. Specify only one of either VirtualMachine OR VirtualMachineDisk. When virtualMachine is specified, the backup strategy is always ProvisionerSpecific. |
virtualMachineDisk string |
The VirtualMachineDisk being backed-up. This is used with VirtualMachineBackupPlanTemplate to automatically generate a VirtualMachineBackupPlan if one does not exist. When virtualMachineDisk is specified to be backed-up, the backup strategy is SnapshotOnly. Specify only one of either VirtualMachine OR VirtualMachineDisk. |
virtualMachineBackupName string |
The name of the VirtualMachineBackup to be created. The backup is always created in the same namespace as the request. |
VirtualMachineBackupRequestStatus
Defines the observed state of VirtualMachineBackupRequest.
Appears in: - VirtualMachineBackupRequest
| Field | Description |
|---|---|
timeToExpire Time |
When this ephemeral resource will be deleted. |
statusField StatusFields |
Describes the observed state of the VirtualMachineBackupRequest |
VirtualMachineBackupScope
Defines the scope of resources for the VirtualMachineBackupPlan to capture.
Appears in: - VirtualMachineBackupConfig
| Field | Description |
|---|---|
selectedVirtualMachines VirtualMachineResourceConfig array |
Specifies the VMs for the VirtualMachineBackupPlan to capture. |
selectedVirtualMachineDisks VirtualMachineResourceConfig array |
Specifies the disks for this VirtualMachineBackupPlan to capture. |
vmResourceLabelSelector object (keys:string, values:string) |
Specifies the label(s) selecting one/multiple VM or VM disk resources in same namespace as backup plan |
VirtualMachineBackupSpec
Defines the desired state of VirtualMachineBackup.
Appears in: - VirtualMachineBackup
| Field | Description |
|---|---|
virtualMachineBackupPlan string |
The name of the VirtualMachineBackupPlan from which this VirtualMachineBackup was created. This VirtualMachineBackupPlan exists in the same namespace as the VirtualMachineBackupPlan. |
backupConfig VirtualMachineBackupConfig |
Defines the configuration and scope of the backup. |
VirtualMachineBackupStatus
Defines the observed state of a VirtualMachineBackup.
Appears in: - VirtualMachineBackup
| Field | Description |
|---|---|
backup string |
The name of the underlying backup which this VirtualMachineBackup references. The backup must be in the same namespace as this VM backup, used in GDC air-gapped Org v1 Architecture. |
backupStatus BackupStatus |
The status of the underlying backup(s) which this VirtualMachineBackup references, used in GDC air-gapped Org v1 Architecture. |
configBackup string |
The name of the underlying Config Backup which this VirtualMachineBackup references. Config refers to VM and VM Disk. The config backup must be in the same namespace as this VM backup, used in GDC air-gapped Org v2 Architecture. |
configBackupStatus BackupStatus |
The status of the underlying config backup which this VirtualMachineBackup references, used in GDC air-gapped Org v2 Architecture. |
volumeBackup string |
The name of the underlying Volume Backup which this VirtualMachineBackup references. The volume backup must be in the same namespace as this VM backup, used in GDC air-gapped Org v2 Architecture. |
volumeBackupStatus BackupStatus |
The status of the underlying volume backup which this VirtualMachineBackup references, used in GDC air-gapped Org v2 Architecture. |
backedUpVirtualMachines string array |
Lists the names of all VMs that are included in this backup. |
backedUpVirtualMachineDisks string array |
Lists the names of all the VM disks that are included in this backup. If this backup is a disk snapshot, this is a list of VM disks that you provide. If this is a VM backup, it is the list of the disks which back that VM. |
VirtualMachineDeleteBackupRequest
The Schema for the VirtualMachineDeleteBackupRequests API.
Appears in: - VirtualMachineDeleteBackupRequestList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineDeleteBackupRequest |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineDeleteBackupRequestSpec |
|
status VirtualMachineDeleteBackupRequestStatus |
VirtualMachineDeleteBackupRequestList
Contains a list of VirtualMachineDeleteBackupRequest.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineDeleteBackupRequestList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineDeleteBackupRequest array |
VirtualMachineDeleteBackupRequestSpec
Defines the desired state of VirtualMachineDeleteBackupRequest.
Appears in: - VirtualMachineDeleteBackupRequest
| Field | Description |
|---|---|
virtualMachineBackupRef LocalObjectReference |
The name of the VirtualMachineBackup to delete. This request is always created in the same namespace as the backup. |
VirtualMachineDeleteBackupRequestStatus
Defines the observed state of VirtualMachineDeleteBackupRequest.
Appears in: - VirtualMachineDeleteBackupRequest
| Field | Description |
|---|---|
timeToExpire Time |
Defines the time to delete this ephemeral resource. |
statusField StatusFields |
Describes the observed state of the VirtualMachineDeleteBackupRequest. |
VirtualMachineDisk
Schema for the virtualmachinedisks API.
Appears in: - VirtualMachineDiskList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineDisk |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineDiskSpec |
|
status VirtualMachineDiskStatus |
VirtualMachineDiskFilterOptions
Specifies the filter options for restoring disks.
Appears in: - FilterSpec
| Field | Description |
|---|---|
allDisks boolean |
Specifies that all disks from VirtualMachineBackup needs to be restored. |
VirtualMachineDiskList
Contains a list of VirtualMachineDisk.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineDiskList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineDisk array |
VirtualMachineDiskSpec
Defines the desired state of VirtualMachineDisk.
Appears in: - VirtualMachineDisk
| Field | Description |
|---|---|
source DiskSource |
Specifies the source from which the disk contents are populated. If this field is omitted a blank disk gets provisioned. |
size Quantity |
Specifies the size of the disk: 5GiB, 600MiB, and so on. Size must be specified for a blank disk. For disks from other sources, the size depends on the source. For image source, the size is optional and is inferred as being equivalent to Image.spec.minimumDiskSize. If the size is specified it has to be greater than the Image.spec.minimumDiskSize. |
type DiskType |
Specifies the type of the disk. Defaults to Standard. In GDC air-gapped, supported types are: Standard, Local. In GDC connected, supported types are: Standard. |
VirtualMachineDiskStatus
Defines the observed state of VirtualMachineDisk.
Appears in: - VirtualMachineDisk
| Field | Description |
|---|---|
phase VirtualMachineDiskPhase |
The current phase of the Disk. |
progress VirtualMachineDiskProgress |
Progress is the current progress of the Disk provision. Value is between 0 and 100 inclusive, N/A if not available. |
size Quantity |
The current size of the disk. |
conditions Condition array |
The latest observations of the VirtualMachineDisk state. |
virtualMachineAttachments VirtualMachineAttachment array |
The list of VirtualMachine instances to which the VirtualMachineDisk is attached. |
replicationStatus DiskReplicationStatus |
The status of disk replication. |
provisionTime Duration |
The time taken to provision the VirtualMachineDisk and to reach a Ready state. The time taken to provision the VirtualMachineDisk and to reach a Ready state. For example, this is the time spent downloading an image, and so on. |
errors VMMError array |
A list of any errors that occurred during the reconciliation of this resource. |
VirtualMachineExternalAccess
Represents the request of accessing the external VRF for a VirtualMachine.
Appears in: - VirtualMachineExternalAccessList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineExternalAccess |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineExternalAccessSpec |
|
status VirtualMachineExternalAccessStatus |
VirtualMachineExternalAccessList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineExternalAccessList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineExternalAccess array |
VirtualMachineExternalAccessSpec
Defines the specification of the VirtualMachineExternalAccess object.
Appears in: - VirtualMachineExternalAccess
| Field | Description |
|---|---|
enabled boolean |
Specifies whether the external vrf is accessible for the VirtualMachine. |
ports ServicePort array |
The list of ports that are exposed by the VirtualMachine ingress service. |
VirtualMachineExternalAccessStatus
Defines the observed state of the VirtualMachineExternalAccess object.
Appears in: - VirtualMachineExternalAccess
| Field | Description |
|---|---|
ingressIP string |
IngressIP specifies the IP address on the VirtualMachine ingress service. |
egressIP string |
EgressIP specifies the IP address on the egress NAT which is used by the VirtualMachine. |
conditions Condition array |
Details of observed state. |
errors VMMError array |
A list of any errors that occurred during the reconciliation of this resource. |
VirtualMachineImage
Represents the disk image that can be used on virtual machine.
Appears in: - VirtualMachineImageList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineImage |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineImageSpec |
|
status VirtualMachineImageStatus |
VirtualMachineImageImport
Represents the operation to import and convert
VM resources that contain data; for example, to import and convert
'VirtualMachineDiskinto aVirtualMachineImage`.
Appears in: - VirtualMachineImageImportList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineImageImport |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineImageImportSpec |
|
status VirtualMachineImageImportStatus |
VirtualMachineImageImportList
A list of VirtualMachineImageImport objects.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineImageImportList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineImageImport array |
VirtualMachineImageImportSpec
Specifies the source and metadata for the image that you want to create.
Appears in: - VirtualMachineImageImport
| Field | Description |
|---|---|
source ImageSourceReference |
Refers to the resource from which contents are imported. The source must be from the same namespace. |
destination ImageDestinationReference |
Refers to the resource to which contents are imported. Only supported in GDC Connected deployments. This field is required if the specified ImageSourceReference is GCS. |
imageMetadata ImageMetadataInput |
Specifies the properties of the VirtualMachineImage you want to create. |
prepareImage boolean |
Specifies whether to prepare this image for a GDC air-gapped deployment with a value to, for example, install the required packages. If this is not specified, preparation occurs only if the image is from object storage. |
prepareOptions ImagePrepareOptions |
These are the options for image preparation. This is only valid when prepareImage is true. |
VirtualMachineImageImportStatus
Provides the image import status.
Appears in: - VirtualMachineImageImport
| Field | Description |
|---|---|
conditions Condition array |
Provide the Ready status of the import progress. |
imageName string |
Refers to the VirtualMachineImage once successfully created. The image is in the same namespace as the image import. |
errors VMMError array |
A list of any errors that occurred during the reconciliation of this resource. |
VirtualMachineImageList
Contains a list of VirtualMachineImage objects.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineImageList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineImage array |
VirtualMachineImageSpec
Defines the specification of the virtual machine image.
Appears in: - VirtualMachineImage
| Field | Description |
|---|---|
operatingSystem OperatingSystemSpec |
The details of the OS. |
minimumDiskSize Quantity |
The minimum size of the disk the image can be applied to. This specifies only the recommended size for the future disks that are created from this image. It does not represent the size of the Image itself. |
gcs GCSReference |
Refers to the GCS resource from which image are stored. |
VirtualMachineImageStatus
Contains the observed state of the VirtualMachineImage object.
Appears in: - VirtualMachineImage
| Field | Description |
|---|---|
conditions Condition array |
The conditions of the virtual machine image. |
errors VMMError array |
A list of any errors that occurred during the reconciliation of this resource. |
storageLocation string |
The zone where this virtual machine image is stored. |
VirtualMachineList
Contains a list of VirtualMachine objects.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachine array |
VirtualMachinePasswordResetRequest
Represents a password reset request for a given VM.
Appears in: - VirtualMachinePasswordResetRequestList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachinePasswordResetRequest |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachinePasswordResetRequestSpec |
|
status VirtualMachinePasswordResetRequestStatus |
VirtualMachinePasswordResetRequestList
Contains a list of VirtualMachinePasswordResetRequest resources.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachinePasswordResetRequestList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachinePasswordResetRequest array |
VirtualMachinePasswordResetRequestSpec
Defines the VirtualMachinePasswordResetRequest specification.
Appears in: - VirtualMachinePasswordResetRequest
| Field | Description |
|---|---|
vmName string |
The name of the VM to request a password reset. This field is immutable and cannot be updated after creating a password reset request. |
user string |
The name of the user to perform the password reset for a specified VM. This field is immutable and cannot be updated after creating a password reset request. |
publicKey string |
The public key to encrypt the new password for a VM. This field is immutable and cannot be updated after creating a password reset request. |
VirtualMachinePasswordResetRequestState
Underlying type: string
Defines the state of a VirtualMachinePasswordResetRequest resource.
Appears in: - VirtualMachinePasswordResetRequestStatus
VirtualMachinePasswordResetRequestStatus
Describes the status of the VirtualMachinePasswordResetRequest resource.
Appears in: - VirtualMachinePasswordResetRequest
| Field | Description |
|---|---|
state VirtualMachinePasswordResetRequestState |
The state of the VirtualMachinePasswordResetRequest resource. |
reason string |
The reason for the current status of the resource. |
message string |
A field that provides additional information for the current status. |
processedAt Time |
A field that specifies the time when the request processed. |
encryptedPassword string |
The new password encrypted using the public key provided in the request and encoded using base64. To decrypt the password, use base64 to decode the string and decrypt the result using RSA decryption. |
errors VMMError array |
A list of any errors that occurred during the reconciliation of this resource. |
VirtualMachineProvisionTime
Tracks the VirtualMachine provision time.
Appears in: - VirtualMachineStatus
| Field | Description |
|---|---|
initProvisionTime Duration |
Time taken for the first VM provision. i.e. Time taken from the object being created till the VM is in running status. |
lastProvisionTime Duration |
Time taken for the most recent VM provision. It can be equal to InitProvisionTime if the VM is only being provisioned once. |
VirtualMachineResourceConfig
Specifies a VM resource and additional parameters for backing up that resource.
Appears in: - FilterSpec - VirtualMachineBackupScope
| Field | Description |
|---|---|
resourceName string |
The name of the resource being backed up. It must exist in the same namespace as the plan. |
VirtualMachineRestore
The Schema for the VirtualMachineRestores API.
Appears in: - VirtualMachineRestoreList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineRestore |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineRestoreSpec |
|
status VirtualMachineRestoreStatus |
VirtualMachineRestoreList
Contains a list of VirtualMachineRestore.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineRestoreList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineRestore array |
VirtualMachineRestoreRequest
The Schema for the VirtualMachineRestoreRequests API.
Appears in: - VirtualMachineRestoreRequestList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineRestoreRequest |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineRestoreRequestSpec |
|
status VirtualMachineRestoreRequestStatus |
VirtualMachineRestoreRequestList
Contains a list of VirtualMachineRestoreRequest.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineRestoreRequestList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineRestoreRequest array |
VirtualMachineRestoreRequestSpec
Defines the desired state of VirtualMachineRestoreRequest.
Appears in: - VirtualMachineRestoreRequest
| Field | Description |
|---|---|
virtualMachineBackup string |
The name of the VM backup that to restore. The VirtualMachineBackup resides in the same namespace as does this VirtualMachineRestoreRequest. |
restoreName string |
The name given to the VirtualMachineRestore resource created. |
restoredResourceName string |
The prefix given to the resources which are restored by VirtualMachineBackup. The name of the restored resource would be the prefix + name of backed up resource. |
restoredResourceDescription string |
The description given to the newly created resource. |
filter FilterSpec |
The filters that can be used to refine the VM resource selection during the Restore. |
VirtualMachineRestoreRequestStatus
Defines the observed state of VirtualMachineRestoreRequest.
Appears in: - VirtualMachineRestoreRequest
| Field | Description |
|---|---|
timeToExpire Time |
When this ephemeral resource will be deleted. |
statusField StatusFields |
Describes the observed state of the VirtualMachineRestoreRequest. |
VirtualMachineRestoreSpec
Defines the desired state of VirtualMachineRestore.
Appears in: - VirtualMachineRestore
| Field | Description |
|---|---|
virtualMachineBackup string |
The name of the VM backup that this VirtualMachineRestore is restoring. The VirtualMachineBackup is in the same namespace as this VirtualMachineRestore. |
targetVirtualMachines string array |
The list of all VMs. created when the underlying restore is successful. |
targetVirtualMachineDisks string array |
The list of all VM disks. created when the underlying restore is successful. |
VirtualMachineRestoreStatus
Defines the observed state of VirtualMachineRestore.
Appears in: - VirtualMachineRestore
| Field | Description |
|---|---|
restore string |
The name of the underlying restore which this VirtualMachineRestore references. The restore must be in the same namespace as this VM backup, used in GDC air-gapped Org v1 Architecture. |
restoreStatus RestoreStatus |
The status of the underlying restore which this VirtualMachineRestore references. Used in GDC air-gapped Org v1 Architecture. |
configRestore string |
The name of the underlying Config Restore which this VirtualMachineRestore references. Config refers to VM and VM Disk. The config restore must be in the same namespace as this VM Restore, used in GDC air-gapped Org v2 Architecture. |
configRestoreStatus RestoreStatus |
The status of the underlying config restore which this VirtualMachineRestore references, used in GDC air-gapped Org v2 Architecture. |
volumeRestore string |
The name of the underlying Volume Restore which this VirtualMachineRestore references. The volume restore must be in the same namespace as this VM Restore, used in GDC air-gapped Org v2 Architecture. |
volumeRestoreStatus RestoreStatus |
The status of the underlying volume restore which this VirtualMachineRestore references, used in GDC air-gapped Org v2 Architecture. |
VirtualMachineSpec
Defines the specification of the Virtual Machine.
Appears in: - VirtualMachine
| Field | Description |
|---|---|
runningState VirtualMachineRunningState |
Indicates the requested running state of the VirtualMachine. Defaults to Running. |
disks DiskAttachment array |
Specifies the list of disks attached to this vm. There must be exactly one boot disk. Changes to disk attachments require a reboot to take effect. |
compute Compute |
Specifies the CPU and Memory of the VM. CPU and Memory can be defined directly or through the VirtualMachineType. Changes to Compute require a reboot to take effect. Compute is immutable when the VM is in Unknown state. |
startupScripts StartupScript array |
Specifies the list of startup scripts for the VM. Linux VMs must have cloud-init installed for StartupScripts to take effect. The scripts are executed in alphabetical order, based on the name of each startup script. In Windows VMs the type of script impacts the order of execution. Scripts are executed in the order ps1, bat, cmd. If two scripts are of the same type they are executed in alphabetical order, based on the name. |
guestEnvironment GuestEnvironment |
Specifies the VM's guest environment configuration. If the field is nil the enable field in AccessManagement is true by default. Otherwise, the non-nil configuration for each sub-feature inside the structure overrides the default configuration of the sub-feature. |
firmware Firmware |
Specifies the VM initialization options at boot time. |
shieldConfig ShieldConfig |
Specifies the VM's security-related configurations. |
network NetworkSpec |
Specifies the network configuration. |
VirtualMachineStatus
Contains the observed state of the Virtual Machine.
Appears in: - VirtualMachine
| Field | Description |
|---|---|
state VirtualMachineState |
Observed state of the VM. |
reason VirtualMachineStateReason |
Reason why the VM is in the observed state. Populated if applicable for the observed state. |
message string |
Additional details about the state of the VM. |
network NetworkStatus |
Status of the VM networks. |
conditions Condition array |
Details of observed state. |
stateTransitionTime object (keys:VirtualMachineState, values:Time) |
Last transition time of each state. |
provisionTime VirtualMachineProvisionTime |
Time taken to provision the VM. |
errors VMMError array |
A list of any errors that occurred during the reconciliation of this resource. |
VirtualMachineType
Defines the CPU and Memory resource of a VM.
Appears in: - VirtualMachineTypeList
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineType |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualMachineTypeSpec |
|
status VirtualMachineTypeStatus |
VirtualMachineTypeList
VirtualMachineTypeList contains a list of VirtualMachineType.
| Field | Description |
|---|---|
apiVersion string |
virtualmachine.gdc.goog/v1 |
kind string |
VirtualMachineTypeList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items VirtualMachineType array |
VirtualMachineTypeSpec
Defines the configurations of a VirtualMachineType.
Appears in: - VirtualMachineType
| Field | Description |
|---|---|
vcpus integer |
Specifies the number of VCPUs that are available to the instance. Specify vcpus as an integer that is a multiple of 2, between 2 and 128, inclusive. |
memory Quantity |
Specifies the amount of physical memory available to the instance. memory must have a value that is between 1G and 400G, inclusive. |
VirtualMachineTypeStatus
Appears in: - VirtualMachineType
| Field | Description |
|---|---|
supported boolean |
Specifies if given vmtype is supported or not by the underlying hardware |