2019-05-31 08:27:41 -04:00
//go:generate struct-markdown
2019-10-14 10:43:59 -04:00
//go:generate mapstructure-to-hcl2 -type Config,CustomerEncryptionKey
2019-05-31 08:27:41 -04:00
2013-12-12 19:41:44 -05:00
package googlecompute
2019-05-05 11:12:30 -04:00
import (
"errors"
"fmt"
"os"
"regexp"
2020-04-29 15:13:22 -04:00
"runtime"
2019-10-31 10:49:34 -04:00
"time"
2013-12-12 19:41:44 -05:00
2019-05-05 11:12:30 -04:00
"github.com/hashicorp/packer/helper/communicator"
"github.com/hashicorp/packer/packer"
2020-11-12 17:44:02 -05:00
"github.com/hashicorp/packer/packer-plugin-sdk/common"
2020-11-18 13:34:59 -05:00
"github.com/hashicorp/packer/packer-plugin-sdk/template/config"
2020-11-11 13:21:37 -05:00
"github.com/hashicorp/packer/packer-plugin-sdk/template/interpolate"
2020-11-12 17:44:02 -05:00
"github.com/hashicorp/packer/packer-plugin-sdk/uuid"
2019-05-05 11:12:30 -04:00
compute "google.golang.org/api/compute/v1"
)
2013-12-12 19:41:44 -05:00
2019-09-16 13:10:37 -04:00
// used for ImageName and ImageFamily
var validImageName = regexp . MustCompile ( ` ^[a-z]([-a-z0-9] { 0,61}[a-z0-9])?$ ` )
2016-05-13 18:37:25 -04:00
2019-05-05 11:12:30 -04:00
// Config is the configuration structure for the GCE builder. It stores
// both the publicly settable state as well as the privately generated
// state of the config object.
type Config struct {
common . PackerConfig ` mapstructure:",squash" `
Comm communicator . Config ` mapstructure:",squash" `
2013-12-12 19:41:44 -05:00
2019-06-12 08:28:11 -04:00
// The JSON file containing your account credentials. Not required if you
// run Packer on a GCE instance with a service account. Instructions for
// creating the file or using service accounts are above.
2019-05-28 11:50:58 -04:00
AccountFile string ` mapstructure:"account_file" required:"false" `
2020-10-01 15:39:06 -04:00
// This allows service account impersonation as per the [docs](https://cloud.google.com/iam/docs/impersonating-service-accounts).
ImpersonateServiceAccount string ` mapstructure:"impersonate_service_account" required:"false" `
2019-06-12 08:28:11 -04:00
// The project ID that will be used to launch instances and store images.
2019-06-06 10:29:25 -04:00
ProjectId string ` mapstructure:"project_id" required:"true" `
2019-06-12 08:28:11 -04:00
// Full or partial URL of the guest accelerator type. GPU accelerators can
2019-06-12 09:18:39 -04:00
// only be used with `"on_host_maintenance": "TERMINATE"` option set.
2019-06-12 08:28:11 -04:00
// Example:
2019-06-12 09:18:39 -04:00
// `"projects/project_id/zones/europe-west1-b/acceleratorTypes/nvidia-tesla-k80"`
2019-06-06 10:29:25 -04:00
AcceleratorType string ` mapstructure:"accelerator_type" required:"false" `
2019-06-12 08:28:11 -04:00
// Number of guest accelerator cards to add to the launched instance.
2019-06-06 10:29:25 -04:00
AcceleratorCount int64 ` mapstructure:"accelerator_count" required:"false" `
2019-06-12 08:28:11 -04:00
// The name of a pre-allocated static external IP address. Note, must be
// the name and not the actual IP address.
2019-06-06 10:29:25 -04:00
Address string ` mapstructure:"address" required:"false" `
2019-06-12 08:28:11 -04:00
// If true, the default service account will not be used if
// service_account_email is not specified. Set this value to true and omit
// service_account_email to provision a VM with no service account.
2019-06-06 10:29:25 -04:00
DisableDefaultServiceAccount bool ` mapstructure:"disable_default_service_account" required:"false" `
2019-06-12 08:28:11 -04:00
// The name of the disk, if unset the instance name will be used.
2019-06-06 10:29:25 -04:00
DiskName string ` mapstructure:"disk_name" required:"false" `
2019-06-12 08:28:11 -04:00
// The size of the disk in GB. This defaults to 10, which is 10GB.
2019-06-06 10:29:25 -04:00
DiskSizeGb int64 ` mapstructure:"disk_size" required:"false" `
2019-06-12 08:28:11 -04:00
// Type of disk used to back your instance, like pd-ssd or pd-standard.
// Defaults to pd-standard.
2019-06-06 10:29:25 -04:00
DiskType string ` mapstructure:"disk_type" required:"false" `
2020-03-30 10:10:51 -04:00
// Create a Shielded VM image with Secure Boot enabled. It helps ensure that
// the system only runs authentic software by verifying the digital signature
// of all boot components, and halting the boot process if signature verification
// fails. [Details](https://cloud.google.com/security/shielded-cloud/shielded-vm)
2020-03-30 09:05:16 -04:00
EnableSecureBoot bool ` mapstructure:"enable_secure_boot" required:"false" `
2020-03-30 10:10:51 -04:00
// Create a Shielded VM image with virtual trusted platform module
// Measured Boot enabled. A vTPM is a virtualized trusted platform module,
// which is a specialized computer chip you can use to protect objects,
// like keys and certificates, that you use to authenticate access to your
// system. [Details](https://cloud.google.com/security/shielded-cloud/shielded-vm)
2020-03-30 09:05:16 -04:00
EnableVtpm bool ` mapstructure:"enable_vtpm" required:"false" `
2020-03-30 10:10:51 -04:00
// Integrity monitoring helps you understand and make decisions about the
// state of your VM instances. Note: integrity monitoring relies on having
// vTPM enabled. [Details](https://cloud.google.com/security/shielded-cloud/shielded-vm)
2020-03-30 09:05:16 -04:00
EnableIntegrityMonitoring bool ` mapstructure:"enable_integrity_monitoring" required:"false" `
2020-04-14 13:28:07 -04:00
// Whether to use an IAP proxy.
IAPConfig ` mapstructure:",squash" `
2020-10-16 18:42:30 -04:00
// Skip creating the image. Useful for setting to `true` during a build test stage. Defaults to `false`.
SkipCreateImage bool ` mapstructure:"skip_create_image" required:"false" `
2019-05-28 11:50:58 -04:00
// The unique name of the resulting image. Defaults to
2020-03-23 20:02:12 -04:00
// `packer-{{timestamp}}`.
2019-06-06 10:29:25 -04:00
ImageName string ` mapstructure:"image_name" required:"false" `
2019-05-28 11:50:58 -04:00
// The description of the resulting image.
2019-06-06 10:29:25 -04:00
ImageDescription string ` mapstructure:"image_description" required:"false" `
2019-05-28 11:50:58 -04:00
// Image encryption key to apply to the created image. Possible values:
2019-06-12 09:18:39 -04:00
// * kmsKeyName - The name of the encryption key that is stored in Google Cloud KMS.
// * RawKey: - A 256-bit customer-supplied encryption key, encodes in RFC 4648 base64.
//
2020-10-27 10:46:45 -04:00
// examples:
2019-06-12 09:18:39 -04:00
//
2020-03-12 10:05:08 -04:00
// ```json
2019-06-12 09:18:39 -04:00
// {
// "kmsKeyName": "projects/${project}/locations/${region}/keyRings/computeEngine/cryptoKeys/computeEngine/cryptoKeyVersions/4"
// }
// ```
2020-10-27 10:46:45 -04:00
//
// ```hcl
// image_encryption_key {
// kmsKeyName = "projects/${var.project}/locations/${var.region}/keyRings/computeEngine/cryptoKeys/computeEngine/cryptoKeyVersions/4"
// }
// ```
2019-10-14 10:02:19 -04:00
ImageEncryptionKey * CustomerEncryptionKey ` mapstructure:"image_encryption_key" required:"false" `
2019-06-12 08:28:11 -04:00
// The name of the image family to which the resulting image belongs. You
// can create disks by specifying an image family instead of a specific
// image name. The image family always returns its latest image that is not
// deprecated.
2019-06-06 10:29:25 -04:00
ImageFamily string ` mapstructure:"image_family" required:"false" `
2019-06-12 08:28:11 -04:00
// Key/value pair labels to apply to the created image.
2019-06-06 10:29:25 -04:00
ImageLabels map [ string ] string ` mapstructure:"image_labels" required:"false" `
2019-06-12 08:28:11 -04:00
// Licenses to apply to the created image.
2019-06-06 10:29:25 -04:00
ImageLicenses [ ] string ` mapstructure:"image_licenses" required:"false" `
2020-06-02 13:42:33 -04:00
// Storage location, either regional or multi-regional, where snapshot
// content is to be stored and only accepts 1 value. Always defaults to a nearby regional or multi-regional
// location.
//
// multi-regional example:
//
// ```json
// {
// "image_storage_locations": ["us"]
// }
// ```
// regional example:
//
// ```json
// {
// "image_storage_locations": ["us-east1"]
// }
// ```
ImageStorageLocations [ ] string ` mapstructure:"image_storage_locations" required:"false" `
2019-06-12 08:28:11 -04:00
// A name to give the launched instance. Beware that this must be unique.
2020-03-23 20:02:12 -04:00
// Defaults to `packer-{{uuid}}`.
2019-06-06 10:29:25 -04:00
InstanceName string ` mapstructure:"instance_name" required:"false" `
2019-06-12 08:28:11 -04:00
// Key/value pair labels to apply to the launched instance.
2019-06-06 10:29:25 -04:00
Labels map [ string ] string ` mapstructure:"labels" required:"false" `
2019-05-28 11:50:58 -04:00
// The machine type. Defaults to "n1-standard-1".
2019-06-06 10:29:25 -04:00
MachineType string ` mapstructure:"machine_type" required:"false" `
2019-06-12 08:28:11 -04:00
// Metadata applied to the launched instance.
2020-06-18 09:50:40 -04:00
// All metadata configuration values are expected to be of type string.
// Google metadata options that take a value of `TRUE` or `FALSE` should be
// set as a string (i.e `"TRUE"` `"FALSE"` or `"true"` `"false"`).
2019-06-06 10:29:25 -04:00
Metadata map [ string ] string ` mapstructure:"metadata" required:"false" `
2019-06-12 08:28:11 -04:00
// Metadata applied to the launched instance. Values are files.
MetadataFiles map [ string ] string ` mapstructure:"metadata_files" `
// A Minimum CPU Platform for VM Instance. Availability and default CPU
// platforms vary across zones, based on the hardware available in each GCP
2019-06-12 09:18:39 -04:00
// zone.
// [Details](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
2019-06-06 10:29:25 -04:00
MinCpuPlatform string ` mapstructure:"min_cpu_platform" required:"false" `
2019-06-12 08:28:11 -04:00
// The Google Compute network id or URL to use for the launched instance.
// Defaults to "default". If the value is not a URL, it will be
// interpolated to
2020-06-02 17:22:40 -04:00
// `projects/((network_project_id))/global/networks/((network))`. This value
2019-06-06 10:29:25 -04:00
// is not required if a subnet is specified.
Network string ` mapstructure:"network" required:"false" `
2019-06-12 08:28:11 -04:00
// The project ID for the network and subnetwork to use for launched
// instance. Defaults to project_id.
2019-06-06 10:29:25 -04:00
NetworkProjectId string ` mapstructure:"network_project_id" required:"false" `
2019-06-12 08:28:11 -04:00
// If true, the instance will not have an external IP. use_internal_ip must
// be true if this property is true.
2019-06-06 10:29:25 -04:00
OmitExternalIP bool ` mapstructure:"omit_external_ip" required:"false" `
2019-06-12 09:18:39 -04:00
// Sets Host Maintenance Option. Valid choices are `MIGRATE` and
// `TERMINATE`. Please see [GCE Instance Scheduling
// Options](https://cloud.google.com/compute/docs/instances/setting-instance-scheduling-options),
// as not all machine\_types support `MIGRATE` (i.e. machines with GPUs).
// If preemptible is true this can only be `TERMINATE`. If preemptible is
// false, it defaults to `MIGRATE`
2019-06-06 10:29:25 -04:00
OnHostMaintenance string ` mapstructure:"on_host_maintenance" required:"false" `
2019-05-28 11:50:58 -04:00
// If true, launch a preemptible instance.
2019-06-06 10:29:25 -04:00
Preemptible bool ` mapstructure:"preemptible" required:"false" `
2019-06-12 08:28:11 -04:00
// The time to wait for instance state changes. Defaults to "5m".
2019-10-31 10:49:34 -04:00
StateTimeout time . Duration ` mapstructure:"state_timeout" required:"false" `
2019-06-12 08:28:11 -04:00
// The region in which to launch the instance. Defaults to the region
// hosting the specified zone.
2019-06-06 10:29:25 -04:00
Region string ` mapstructure:"region" required:"false" `
2019-06-12 09:18:39 -04:00
// The service account scopes for launched
// instance. Defaults to:
//
2020-03-12 10:05:08 -04:00
// ```json
2019-06-12 09:18:39 -04:00
// [
// "https://www.googleapis.com/auth/userinfo.email",
// "https://www.googleapis.com/auth/compute",
// "https://www.googleapis.com/auth/devstorage.full_control"
// ]
// ```
2019-06-06 10:29:25 -04:00
Scopes [ ] string ` mapstructure:"scopes" required:"false" `
2019-06-12 08:28:11 -04:00
// The service account to be used for launched instance. Defaults to the
// project's default service account unless disable_default_service_account
// is true.
2019-06-06 10:29:25 -04:00
ServiceAccountEmail string ` mapstructure:"service_account_email" required:"false" `
2019-06-12 08:28:11 -04:00
// The source image to use to create the new image from. You can also
// specify source_image_family instead. If both source_image and
// source_image_family are specified, source_image takes precedence.
// Example: "debian-8-jessie-v20161027"
2019-06-06 10:29:25 -04:00
SourceImage string ` mapstructure:"source_image" required:"true" `
2019-06-12 08:28:11 -04:00
// The source image family to use to create the new image from. The image
// family always returns its latest image that is not deprecated. Example:
// "debian-8".
2019-06-06 10:29:25 -04:00
SourceImageFamily string ` mapstructure:"source_image_family" required:"true" `
2020-02-20 06:54:35 -05:00
// A list of project IDs to search for the source image. Packer will search the first
// project ID in the list first, and fall back to the next in the list, until it finds the source image.
2020-02-06 04:27:01 -05:00
SourceImageProjectId [ ] string ` mapstructure:"source_image_project_id" required:"false" `
2020-06-25 21:21:10 -04:00
// The path to a startup script to run on the launched instance from which the image will
// be made. When set, the contents of the startup script file will be added to the instance metadata
// under the `"startup_script"` metadata property. See [Providing startup script contents directly](https://cloud.google.com/compute/docs/startupscript#providing_startup_script_contents_directly) for more details.
//
// When using `startup_script_file` the following rules apply:
// - The contents of the script file will overwrite the value of the `"startup_script"` metadata property at runtime.
// - The contents of the script file will be wrapped in Packer's startup script wrapper, unless `wrap_startup_script` is disabled. See `wrap_startup_script` for more details.
// - Not supported by Windows instances. See [Startup Scripts for Windows](https://cloud.google.com/compute/docs/startupscript#providing_a_startup_script_for_windows_instances) for more details.
2019-06-06 10:29:25 -04:00
StartupScriptFile string ` mapstructure:"startup_script_file" required:"false" `
2020-06-25 21:21:10 -04:00
// For backwards compatibility this option defaults to `"true"` in the future it will default to `"false"`.
// If "true", the contents of `startup_script_file` or `"startup_script"` in the instance metadata
// is wrapped in a Packer specific script that tracks the execution and completion of the provided
// startup script. The wrapper ensures that the builder will not continue until the startup script has been executed.
// - The use of the wrapped script file requires that the user or service account
// running the build has the compute.instance.Metadata role.
WrapStartupScriptFile config . Trilean ` mapstructure:"wrap_startup_script" required:"false" `
2019-06-12 08:28:11 -04:00
// The Google Compute subnetwork id or URL to use for the launched
// instance. Only required if the network has been created with custom
// subnetting. Note, the region of the subnetwork must match the region or
// zone in which the VM is launched. If the value is not a URL, it will be
// interpolated to
2020-06-02 17:22:40 -04:00
// `projects/((network_project_id))/regions/((region))/subnetworks/((subnetwork))`
2019-06-06 10:29:25 -04:00
Subnetwork string ` mapstructure:"subnetwork" required:"false" `
2019-06-12 08:28:11 -04:00
// Assign network tags to apply firewall rules to VM instance.
2019-06-06 10:29:25 -04:00
Tags [ ] string ` mapstructure:"tags" required:"false" `
2019-06-12 08:28:11 -04:00
// If true, use the instance's internal IP instead of its external IP
// during building.
2019-06-06 10:29:25 -04:00
UseInternalIP bool ` mapstructure:"use_internal_ip" required:"false" `
2020-07-08 06:30:25 -04:00
// If true, OSLogin will be used to manage SSH access to the compute instance by
// dynamically importing a temporary SSH key to the Google account's login profile,
// and setting the `enable-oslogin` to `TRUE` in the instance metadata.
// Optionally, `use_os_login` can be used with an existing `ssh_username` and `ssh_private_key_file`
// if a SSH key has already been added to the Google account's login profile - See [Adding SSH Keys](https://cloud.google.com/compute/docs/instances/managing-instance-access#add_oslogin_keys).
//
// SSH keys can be added to an individual user account
//
//```shell-session
// $ gcloud compute os-login ssh-keys add --key-file=/home/user/.ssh/my-key.pub
//
// $ gcloud compute os-login describe-profile
//PosixAccounts:
//- accountId: <project-id>
// gid: '34567890754'
// homeDirectory: /home/user_example_com
// ...
// primary: true
// uid: '2504818925'
// username: /home/user_example_com
//sshPublicKeys:
// 000000000000000000000000000000000000000000000000000000000000000a:
// fingerprint: 000000000000000000000000000000000000000000000000000000000000000a
//```
//
// Or SSH keys can be added to an associated service account
//```shell-session
// $ gcloud auth activate-service-account --key-file=<path to service account credentials file (e.g account.json)>
// $ gcloud compute os-login ssh-keys add --key-file=/home/user/.ssh/my-key.pub
//
// $ gcloud compute os-login describe-profile
//PosixAccounts:
//- accountId: <project-id>
// gid: '34567890754'
// homeDirectory: /home/sa_000000000000000000000
// ...
// primary: true
// uid: '2504818925'
// username: sa_000000000000000000000
//sshPublicKeys:
// 000000000000000000000000000000000000000000000000000000000000000a:
// fingerprint: 000000000000000000000000000000000000000000000000000000000000000a
//```
UseOSLogin bool ` mapstructure:"use_os_login" required:"false" `
2019-09-20 19:52:35 -04:00
// Can be set instead of account_file. If set, this builder will use
// HashiCorp Vault to generate an Oauth token for authenticating against
2020-09-20 10:18:37 -04:00
// Google Cloud. The value should be the path of the token generator
2019-09-20 19:52:35 -04:00
// within vault.
// For information on how to configure your Vault + GCP engine to produce
2020-03-31 18:19:18 -04:00
// Oauth tokens, see https://www.vaultproject.io/docs/auth/gcp
2019-09-20 19:52:35 -04:00
// You must have the environment variables VAULT_ADDR and VAULT_TOKEN set,
// along with any other relevant variables for accessing your vault
// instance. For more information, see the Vault docs:
// https://www.vaultproject.io/docs/commands/#environment-variables
// Example:`"vault_gcp_oauth_engine": "gcp/token/my-project-editor",`
VaultGCPOauthEngine string ` mapstructure:"vault_gcp_oauth_engine" `
2019-06-12 08:28:11 -04:00
// The zone in which to launch the instance used to create the image.
// Example: "us-central1-a"
2020-11-27 13:13:10 -05:00
// The time to wait between instance creation and adding SSH keys.
// Example value: `5m`.
WaitToAddSSHKeys time . Duration ` mapstructure:"wait_to_add_ssh_keys" `
2019-06-06 10:29:25 -04:00
Zone string ` mapstructure:"zone" required:"true" `
2018-02-21 12:22:39 -05:00
2020-09-20 10:18:37 -04:00
account * ServiceAccount
2019-05-05 11:12:30 -04:00
imageAlreadyExists bool
ctx interpolate . Context
}
2019-12-17 05:25:56 -05:00
func ( c * Config ) Prepare ( raws ... interface { } ) ( [ ] string , error ) {
2019-05-05 11:12:30 -04:00
c . ctx . Funcs = TemplateFuncs
err := config . Decode ( c , & config . DecodeOpts {
2020-10-21 19:07:18 -04:00
PluginType : BuilderId ,
2019-05-05 11:12:30 -04:00
Interpolate : true ,
InterpolateContext : & c . ctx ,
InterpolateFilter : & interpolate . RenderFilter {
Exclude : [ ] string {
"run_command" ,
} ,
} ,
} , raws ... )
if err != nil {
2019-12-17 05:25:56 -05:00
return nil , err
2019-05-05 11:12:30 -04:00
}
var errs * packer . MultiError
// Set defaults.
if c . Network == "" && c . Subnetwork == "" {
c . Network = "default"
}
if c . NetworkProjectId == "" {
c . NetworkProjectId = c . ProjectId
}
if c . DiskSizeGb == 0 {
2020-05-08 09:55:38 -04:00
c . DiskSizeGb = 20
2019-05-05 11:12:30 -04:00
}
if c . DiskType == "" {
c . DiskType = "pd-standard"
}
2020-03-30 09:05:16 -04:00
// Disabling the vTPM also disables integrity monitoring, because integrity
// monitoring relies on data gathered by Measured Boot.
if ! c . EnableVtpm {
if c . EnableIntegrityMonitoring {
errs = packer . MultiErrorAppend ( errs ,
errors . New ( "You cannot enable Integrity Monitoring when vTPM is disabled." ) )
}
}
2019-05-05 11:12:30 -04:00
if c . ImageDescription == "" {
c . ImageDescription = "Created by Packer"
}
if c . OnHostMaintenance == "MIGRATE" && c . Preemptible {
errs = packer . MultiErrorAppend ( errs ,
errors . New ( "on_host_maintenance must be TERMINATE when using preemptible instances." ) )
}
// Setting OnHostMaintenance Correct Defaults
// "MIGRATE" : Possible and default if Preemptible is false
// "TERMINATE": Required if Preemptible is true
if c . Preemptible {
c . OnHostMaintenance = "TERMINATE"
} else {
if c . OnHostMaintenance == "" {
c . OnHostMaintenance = "MIGRATE"
}
}
// Make sure user sets a valid value for on_host_maintenance option
if ! ( c . OnHostMaintenance == "MIGRATE" || c . OnHostMaintenance == "TERMINATE" ) {
errs = packer . MultiErrorAppend ( errs ,
errors . New ( "on_host_maintenance must be one of MIGRATE or TERMINATE." ) )
}
if c . ImageName == "" {
img , err := interpolate . Render ( "packer-{{timestamp}}" , nil )
if err != nil {
errs = packer . MultiErrorAppend ( errs ,
fmt . Errorf ( "Unable to parse image name: %s " , err ) )
} else {
c . ImageName = img
}
}
2019-09-16 13:10:37 -04:00
// used for ImageName and ImageFamily
2019-09-16 16:50:43 -04:00
imageErrorText := "Invalid image %s %q: The first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash"
2019-09-16 13:10:37 -04:00
if len ( c . ImageName ) > 63 {
errs = packer . MultiErrorAppend ( errs ,
errors . New ( "Invalid image name: Must not be longer than 63 characters" ) )
}
if ! validImageName . MatchString ( c . ImageName ) {
2019-09-16 16:50:43 -04:00
errs = packer . MultiErrorAppend ( errs , errors . New ( fmt . Sprintf ( imageErrorText , "name" , c . ImageName ) ) )
2019-09-16 13:10:37 -04:00
}
2019-05-05 11:12:30 -04:00
if len ( c . ImageFamily ) > 63 {
errs = packer . MultiErrorAppend ( errs ,
errors . New ( "Invalid image family: Must not be longer than 63 characters" ) )
}
if c . ImageFamily != "" {
2019-09-16 13:10:37 -04:00
if ! validImageName . MatchString ( c . ImageFamily ) {
2019-09-16 16:50:43 -04:00
errs = packer . MultiErrorAppend ( errs , errors . New ( fmt . Sprintf ( imageErrorText , "family" , c . ImageFamily ) ) )
2019-05-05 11:12:30 -04:00
}
}
2020-06-02 13:42:33 -04:00
if len ( c . ImageStorageLocations ) > 1 {
errs = packer . MultiErrorAppend ( errs ,
errors . New ( "Invalid image storage locations: Must not have more than 1 region" ) )
}
2019-05-05 11:12:30 -04:00
if c . InstanceName == "" {
c . InstanceName = fmt . Sprintf ( "packer-%s" , uuid . TimeOrderedUUID ( ) )
}
if c . DiskName == "" {
c . DiskName = c . InstanceName
}
if c . MachineType == "" {
c . MachineType = "n1-standard-1"
}
2013-12-12 19:41:44 -05:00
2019-10-31 10:49:34 -04:00
if c . StateTimeout == 0 {
c . StateTimeout = 5 * time . Minute
2019-05-05 11:12:30 -04:00
}
2020-04-14 13:28:07 -04:00
// Set up communicator
2019-05-05 11:12:30 -04:00
if es := c . Comm . Prepare ( & c . ctx ) ; len ( es ) > 0 {
errs = packer . MultiErrorAppend ( errs , es ... )
}
2020-04-14 13:28:07 -04:00
// set defaults for IAP
if c . IAPConfig . IAPHashBang == "" {
2020-04-29 15:13:22 -04:00
if runtime . GOOS == "windows" {
c . IAPConfig . IAPHashBang = ""
} else {
c . IAPConfig . IAPHashBang = "/bin/sh"
}
2020-04-14 13:28:07 -04:00
}
if c . IAPConfig . IAPExt == "" {
2020-04-29 15:13:22 -04:00
if runtime . GOOS == "windows" {
c . IAPConfig . IAPExt = ".cmd"
}
2020-04-14 13:28:07 -04:00
}
2020-07-10 14:25:54 -04:00
if c . IAPConfig . IAPTunnelLaunchWait == 0 {
2020-07-18 18:54:17 -04:00
if c . Comm . Type == "winrm" {
// when starting up, WinRM can cause the tunnel to take 30 seconds
// before timing out
c . IAPConfig . IAPTunnelLaunchWait = 40
} else {
c . IAPConfig . IAPTunnelLaunchWait = 30
}
2020-07-07 18:37:45 -04:00
}
2020-04-14 13:28:07 -04:00
// Configure IAP: Update SSH config to use localhost proxy instead
2020-04-23 18:30:33 -04:00
if c . IAPConfig . IAP {
2020-07-18 18:54:17 -04:00
if ! SupportsIAPTunnel ( & c . Comm ) {
err := fmt . Errorf ( "Error: IAP tunnel is not implemented for %s communicator" , c . Comm . Type )
2020-04-23 18:30:33 -04:00
errs = packer . MultiErrorAppend ( errs , err )
}
2020-07-18 18:54:17 -04:00
// These configuration values are copied early to the generic host parameter when configuring
// StepConnect. As such they must be set now. Ideally we would handle this as part of
// ApplyIAPTunnel and set them during StepStartTunnel but that means defering when the
// CommHost function reads the value from the configuration, perhaps pass in b.config.Comm
// instead of b.config.Comm.Host()?
c . Comm . SSHHost = "localhost"
c . Comm . WinRMHost = "localhost"
2020-04-14 13:28:07 -04:00
}
2019-05-05 11:12:30 -04:00
// Process required parameters.
if c . ProjectId == "" {
errs = packer . MultiErrorAppend (
errs , errors . New ( "a project_id must be specified" ) )
}
if c . Scopes == nil {
c . Scopes = [ ] string {
"https://www.googleapis.com/auth/userinfo.email" ,
"https://www.googleapis.com/auth/compute" ,
"https://www.googleapis.com/auth/devstorage.full_control" ,
}
}
if c . SourceImage == "" && c . SourceImageFamily == "" {
errs = packer . MultiErrorAppend (
errs , errors . New ( "a source_image or source_image_family must be specified" ) )
}
if c . Zone == "" {
errs = packer . MultiErrorAppend (
errs , errors . New ( "a zone must be specified" ) )
}
if c . Region == "" && len ( c . Zone ) > 2 {
// get region from Zone
region := c . Zone [ : len ( c . Zone ) - 2 ]
c . Region = region
}
2019-09-20 19:52:35 -04:00
// Authenticating via an account file
2019-05-05 11:12:30 -04:00
if c . AccountFile != "" {
2020-10-01 15:39:06 -04:00
if c . VaultGCPOauthEngine != "" && c . ImpersonateServiceAccount != "" {
2019-09-20 19:52:35 -04:00
errs = packer . MultiErrorAppend ( errs , fmt . Errorf ( "You cannot " +
2020-10-01 15:39:06 -04:00
"specify impersonate_service_account, account_file and vault_gcp_oauth_engine at the same time" ) )
2019-09-20 19:52:35 -04:00
}
2019-07-02 19:16:13 -04:00
cfg , err := ProcessAccountFile ( c . AccountFile )
if err != nil {
2019-05-05 11:12:30 -04:00
errs = packer . MultiErrorAppend ( errs , err )
}
2019-10-14 10:02:19 -04:00
c . account = cfg
2019-05-05 11:12:30 -04:00
}
if c . OmitExternalIP && c . Address != "" {
errs = packer . MultiErrorAppend ( fmt . Errorf ( "you can not specify an external address when 'omit_external_ip' is true" ) )
}
if c . OmitExternalIP && ! c . UseInternalIP {
errs = packer . MultiErrorAppend ( fmt . Errorf ( "'use_internal_ip' must be true if 'omit_external_ip' is true" ) )
}
if c . AcceleratorCount > 0 && len ( c . AcceleratorType ) == 0 {
errs = packer . MultiErrorAppend ( fmt . Errorf ( "'accelerator_type' must be set when 'accelerator_count' is more than 0" ) )
}
if c . AcceleratorCount > 0 && c . OnHostMaintenance != "TERMINATE" {
errs = packer . MultiErrorAppend ( fmt . Errorf ( "'on_host_maintenance' must be set to 'TERMINATE' when 'accelerator_count' is more than 0" ) )
}
// If DisableDefaultServiceAccount is provided, don't allow a value for ServiceAccountEmail
if c . DisableDefaultServiceAccount && c . ServiceAccountEmail != "" {
errs = packer . MultiErrorAppend ( fmt . Errorf ( "you may not specify a 'service_account_email' when 'disable_default_service_account' is true" ) )
}
if c . StartupScriptFile != "" {
if _ , err := os . Stat ( c . StartupScriptFile ) ; err != nil {
errs = packer . MultiErrorAppend (
errs , fmt . Errorf ( "startup_script_file: %v" , err ) )
}
2020-06-25 21:21:10 -04:00
if c . WrapStartupScriptFile == config . TriUnset {
c . WrapStartupScriptFile = config . TriTrue
}
2019-05-05 11:12:30 -04:00
}
// Check for any errors.
if errs != nil && len ( errs . Errors ) > 0 {
2019-12-17 05:25:56 -05:00
return nil , errs
2019-05-05 11:12:30 -04:00
}
2019-12-17 05:25:56 -05:00
return nil , nil
2019-05-05 11:12:30 -04:00
}
2016-07-07 17:50:46 -04:00
2019-10-14 10:02:19 -04:00
type CustomerEncryptionKey struct {
// KmsKeyName: The name of the encryption key that is stored in Google
// Cloud KMS.
2020-10-27 10:46:45 -04:00
KmsKeyName string ` mapstructure:"kmsKeyName" json:"kmsKeyName,omitempty" `
2019-10-14 10:02:19 -04:00
// RawKey: Specifies a 256-bit customer-supplied encryption key, encoded
// in RFC 4648 base64 to either encrypt or decrypt this resource.
2020-10-27 10:46:45 -04:00
RawKey string ` mapstructure:"rawKey" json:"rawKey,omitempty" `
2019-10-14 10:02:19 -04:00
}
func ( k * CustomerEncryptionKey ) ComputeType ( ) * compute . CustomerEncryptionKey {
if k == nil {
return nil
}
return & compute . CustomerEncryptionKey {
KmsKeyName : k . KmsKeyName ,
RawKey : k . RawKey ,
}
}
2020-07-18 18:54:17 -04:00
func SupportsIAPTunnel ( c * communicator . Config ) bool {
switch c . Type {
case "ssh" , "winrm" :
return true
default :
return false
}
}
func ApplyIAPTunnel ( c * communicator . Config , port int ) error {
switch c . Type {
case "ssh" :
c . SSHPort = port
return nil
case "winrm" :
c . WinRMPort = port
return nil
default :
return fmt . Errorf ( "IAP tunnel is not implemented for %s communicator" , c . Type )
}
}