gce_vm_image_import

README

Compute Engine VM Image Import

The gce_vm_image_import tool imports a VM image to Google Compute Engine image. It uses Daisy to perform imports while adding additional logic to perform import setup and clean-up, such as creating a temporary bucket, validating flags etc.

Build

Download and install Go. Then pull and install the gce_vm_image_import tool, this should place the binary in the Go bin directory:

go get github.com/GoogleCloudPlatform/compute-image-import/cli_tools/gce_vm_image_import

Flags

Required flags

• -image_name=IMAGE_NAME Name of the disk image to create.

Exactly one of these must be specified:

• -source_file=SOURCE_FILE Google Cloud Storage URI of the virtual disk file to import. For example: gs://my-bucket/my-image.vmdk.
• -source_image=SOURCE_IMAGE An existing Compute Engine image from which to import.

Optional flags

• -client_id=CLIENT_ID Identifies the client of the importer. For example: gcloud or pantheon.
• -no_guest_environment Google Guest Environment will not be installed on the image.
• -family=FAMILY Family to set for the translated image.
• -description=DESCRIPTION Description to set for the translated image.
• -network=NETWORK Name of the network in your project to use for the image import. The network must have access to Google Cloud Storage. If not specified, the network named 'default' is used.
• -subnet=SUBNET Name of the subnetwork in your project to use for the image import. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. Region or zone should be specified if this field is specified.
• -zone=ZONE Zone of the image to import. The zone in which to do the work of importing the image. Overrides the default compute/zone property value for this command invocation.
• -timeout=TIMEOUT Maximum time a build can last before it is failed as "TIMEOUT". For example, specifying 2h will fail the process after 2 hours.
• -project=PROJECT Project to run in, overrides what is set in workflow.
• -scratch_bucket_gcs_path=PATH GCS scratch bucket to use, overrides default set in Daisy.
• -oauth=OAUTH_PATH Path to oauth json file, overrides what is set in workflow.
• -compute_endpoint_override=ENDPOINT API endpoint to override default for Compute.
• -storage_endpoint_override=ENDPOINT API endpoint to override default for Storage.
• -cloud_logging_endpoint_override=ENDPOINT API endpoint to override default for Cloud Logging.
• -disable_gcs_logging Do not stream logs to GCS
• -disable_cloud_logging Do not stream logs to Cloud Logging
• -disable_stdout_logging Do not display individual workflow logs on stdout
• -kms_key=KMS_KEY_ID ID of the key or fully qualified identifier for the key. This flag must be specified if any of the other arguments below are specified.
• -kms_keyring=KMS_KEYRING The KMS keyring of the key.
• -kms_location=KMS_LOCATION The Cloud location for the key.
• -kms_project=KMS_PROJECT The Cloud project for the key
• -no_external_ip Temporary VMs are created in your project during image import. Set this flag so that these temporary VMs are not assigned external IP addresses. For more information, see: https://cloud.google.com/compute/docs/import/importing-virtual-disks#no-external-ip
• -labels=[KEY=VALUE,...] labels: List of label KEY=VALUE pairs to add. Keys must start with a lowercase character and contain only hyphens (-), underscores (), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (), lowercase characters, and numbers.
• -storage_location Location (a region or a multi-region) for the imported image which can be any GCS location. If the location parameter is not included, images are created in the multi-region associated with the source disk, image, snapshot or GCS bucket.
• -compute_service_account Compute service account to be used by importer Virtual Machine. When empty, the default Compute Engine service account is used.
• -uefi_compatible Enables UEFI booting, which is an alternative system boot method.
• -sysprep_windows Generalize image using Windows Sysprep. Only applicable to Windows.
• -client_version Identifies the version of the client of the importer.
• -execution_id The execution ID to differentiate GCE resources of each imports.
• -data_disk Specifies that the disk has no bootable OS installed on it. Imports the disk without making it bootable or installing Google tools on it. It's an error to specify -os or -byol when -data_disk is specified.
• -os=OS Specifies the OS of the image being imported. Execute the tool with -help to see the list of currently-supported operating systems.
• -byol Import using an existing license. These are functionally equivalent:
  • -byol -os=rhel-8
  • -byol -os=rhel-8-byol
  • -os=rhel-8-byol

Usage

gce_vm_image_import -image_name=IMAGE_NAME [-client_id=CLIENT_ID] [-data_disk | -byol -os=OS]
        (-source_file=SOURCE_FILE | -source_image=SOURCE_IMAGE) [-no_guest_environment]
        [-family=FAMILY] [-description=DESCRIPTION] [-network=NETWORK] [-subnet=SUBNET]
        [-zone=ZONE] [-timeout=TIMEOUT] [-project=PROJECT] [-scratch_bucket_gcs_path=PATH]
        [-oauth=OAUTH_PATH] [-compute_endpoint_override=ENDPOINT] [-disable_gcs_logging]
        [-disable_cloud_logging] [-disable_stdout_logging]
        [-kms_key=KMS_KEY -kms_keyring=KMS_KEYRING -kms_location=KMS_LOCATION
        -kms_project=KMS_PROJECT] [-no_external_ip] [-labels=KEY=VALUE,...]
        [-storage_location=STORAGE_LOCATION]
        [-compute_service_account=COMPUTE_SERVICE_ACCOUNT]
        [-uefi_compatible] [-sysprep_windows]
        [-client_version=CLIENT_VERSION] [-execution_id=EXECUTION_ID]