Create a VM with a custom hostname that conforms to the RFC 1035 requirements for valid hostnames.
Explore further
For detailed documentation that includes this code sample, see the following:
Code sample
Go
Before trying this sample, follow the Go setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Go API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
import
(
"context"
"fmt"
"io"
compute
"cloud.google.com/go/compute/apiv1"
computepb
"cloud.google.com/go/compute/apiv1/computepb"
"google.golang.org/protobuf/proto"
)
// createInstanceWithCustomHostname creates an instance with custom hostname.
func
createInstanceWithCustomHostname
(
w
io
.
Writer
,
projectID
,
zone
,
instanceName
,
hostname
,
machineType
,
sourceImage
,
networkName
string
)
error
{
// projectID := "your_project_id"
// zone := "europe-central2-b"
// instanceName := "your_instance_name"
// hostname := "host.example.com" // Custom hostnames must conform to RFC 1035 requirements for valid hostnames.
// machineType := "n1-standard-1"
// sourceImage := "projects/debian-cloud/global/images/family/debian-12"
// networkName := "global/networks/default"
ctx
:=
context
.
Background
()
instancesClient
,
err
:=
compute
.
NewInstancesRESTClient
(
ctx
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"NewInstancesRESTClient: %w"
,
err
)
}
defer
instancesClient
.
Close
()
req
:=
& computepb
.
InsertInstanceRequest
{
Project
:
projectID
,
Zone
:
zone
,
InstanceResource
:
& computepb
.
Instance
{
Name
:
proto
.
String
(
instanceName
),
// Custom hostnames are not resolved by the automatically created records
// provided by Compute Engine internal DNS.
// You must manually configure the DNS record for your custom hostname.
Hostname
:
proto
.
String
(
hostname
),
Disks
:
[]
*
computepb
.
AttachedDisk
{
{
// Describe the size and source image of the boot disk to attach to the instance.
InitializeParams
:
& computepb
.
AttachedDiskInitializeParams
{
DiskSizeGb
:
proto
.
Int64
(
10
),
SourceImage
:
proto
.
String
(
sourceImage
),
},
AutoDelete
:
proto
.
Bool
(
true
),
Boot
:
proto
.
Bool
(
true
),
Type
:
proto
.
String
(
computepb
.
AttachedDisk_PERSISTENT
.
String
()),
},
},
MachineType
:
proto
.
String
(
fmt
.
Sprintf
(
"zones/%s/machineTypes/%s"
,
zone
,
machineType
)),
NetworkInterfaces
:
[]
*
computepb
.
NetworkInterface
{
{
// Use the network interface provided in the networkName argument.
Name
:
proto
.
String
(
networkName
),
},
},
},
}
op
,
err
:=
instancesClient
.
Insert
(
ctx
,
req
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"unable to create instance: %w"
,
err
)
}
if
err
=
op
.
Wait
(
ctx
);
err
!=
nil
{
return
fmt
.
Errorf
(
"unable to wait for the operation: %w"
,
err
)
}
fmt
.
Fprintf
(
w
,
"Instance created\n"
)
return
nil
}
Java
Before trying this sample, follow the Java setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Java API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
import
com.google.cloud.compute.v1. AttachedDisk
;
import
com.google.cloud.compute.v1. AttachedDiskInitializeParams
;
import
com.google.cloud.compute.v1. InsertInstanceRequest
;
import
com.google.cloud.compute.v1. Instance
;
import
com.google.cloud.compute.v1. InstancesClient
;
import
com.google.cloud.compute.v1. NetworkInterface
;
import
com.google.cloud.compute.v1. Operation
;
import
java.io.IOException
;
import
java.util.concurrent.ExecutionException
;
import
java.util.concurrent.TimeUnit
;
import
java.util.concurrent.TimeoutException
;
public
class
CreateInstanceWithCustomHostname
{
public
static
void
main
(
String
[]
args
)
throws
IOException
,
ExecutionException
,
InterruptedException
,
TimeoutException
{
// TODO(developer): Replace these variables before running the sample.
// hostName: Custom hostname of the new VM instance.
// * Custom hostnames must conform to RFC 1035 requirements for valid hostnames.
String
project
=
"your-project-id"
;
String
zone
=
"zone-name"
;
// eg: "us-central1-a"
String
instanceName
=
"instance-name"
;
String
hostName
=
"host.example.com"
;
createInstanceWithCustomHostname
(
project
,
zone
,
instanceName
,
hostName
);
}
// Creates an instance with custom hostname.
public
static
void
createInstanceWithCustomHostname
(
String
projectId
,
String
zone
,
String
instanceName
,
String
hostName
)
throws
IOException
,
ExecutionException
,
InterruptedException
,
TimeoutException
{
// machineType - Machine type for the VM instance specified in the following format:
// * "zones/{zone}/machineTypes/{type_name}". For example:
// * "zones/europe-west3-c/machineTypes/f1-micro"
// * You can find the list of available machine types by using this gcloud command:
// * $ gcloud compute machine-types list
// sourceImage - Path of the disk image you want to use for your boot
// * disk. This image can be one of the public images
// * eg: "projects/...
// * or a private image you have access to.
// * You can check the list of available public images using:
// * $ gcloud compute images list
// networkName - Name of the network you want the new instance to use.
// * For example: global/networks/default - if you want to use the default network.
String
machineType
=
"n1-standard-1"
;
String
sourceImage
=
String
.
format
(
"projects/%s/global/images/family/%s"
,
"debian-cloud"
,
"debian-11"
);
String
networkName
=
"global/networks/default"
;
try
(
InstancesClient
instancesClient
=
InstancesClient
.
create
())
{
System
.
out
.
printf
(
"Creating the %s instance in %s with hostname %s..."
,
instanceName
,
zone
,
hostName
);
AttachedDisk
disk
=
AttachedDisk
.
newBuilder
()
.
setBoot
(
true
)
.
setAutoDelete
(
true
)
.
setType
(
AttachedDisk
.
Type
.
PERSISTENT
.
toString
())
.
setInitializeParams
(
// Describe the size and source image of the boot disk to attach to the instance.
AttachedDiskInitializeParams
.
newBuilder
()
.
setSourceImage
(
sourceImage
)
.
setDiskSizeGb
(
10
).
build
())
.
build
();
// Use the network interface provided in the networkName argument.
NetworkInterface
networkInterface
=
NetworkInterface
.
newBuilder
()
.
setName
(
networkName
)
.
build
();
Instance
instanceResource
=
Instance
.
newBuilder
()
// Custom hostnames are not resolved by the automatically created records
// provided by Compute Engine internal DNS.
// You must manually configure the DNS record for your custom hostname.
.
setName
(
instanceName
)
.
setHostname
(
hostName
)
.
addDisks
(
disk
)
.
setMachineType
(
String
.
format
(
"zones/%s/machineTypes/%s"
,
zone
,
machineType
))
.
addNetworkInterfaces
(
networkInterface
).
build
();
InsertInstanceRequest
request
=
InsertInstanceRequest
.
newBuilder
()
.
setProject
(
projectId
)
.
setZone
(
zone
)
.
setInstanceResource
(
instanceResource
).
build
();
// Wait for the create operation to complete.
Operation
response
=
instancesClient
.
insertAsync
(
request
).
get
(
3
,
TimeUnit
.
MINUTES
);
;
if
(
response
.
hasError
())
{
System
.
out
.
printf
(
"Instance creation failed for instance: %s ; Response: %s ! ! "
,
instanceName
,
response
);
return
;
}
System
.
out
.
printf
(
"Instance created : %s"
,
instanceName
);
System
.
out
.
printf
(
"Operation Status for instance %s is %s: "
,
instanceName
,
response
.
getStatus
());
}
}
}
Node.js
Before trying this sample, follow the Node.js setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Node.js API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
/**
* TODO(developer): Uncomment and replace these variables before running the sample.
*/
// const projectId = 'YOUR_PROJECT_ID';
// const zone = 'europe-central2-b'
// const instanceName = 'YOUR_INSTANCE_NAME'
// const hostname = 'host.example.com'
// const machineType = 'n1-standard-1';
// const sourceImage = 'projects/debian-cloud/global/images/family/debian-11';
// const networkName = 'global/networks/default';
const
compute
=
require
(
' @google-cloud/compute
'
);
// Create a new instance with the values provided above in the specified project and zone.
async
function
createInstanceWithCustomHostname
()
{
const
instancesClient
=
new
compute
.
InstancesClient
();
console
.
log
(
`Creating the
${
instanceName
}
instance in
${
zone
}
with hostname
${
hostname
}
...`
);
const
[
response
]
=
await
instancesClient
.
insert
({
instanceResource
:
{
name
:
instanceName
,
// Custom hostnames are not resolved by the automatically created records
// provided by Compute Engine internal DNS.
// You must manually configure the DNS record for your custom hostname.
hostname
,
disks
:
[
{
// Describe the size and source image of the boot disk to attach to the instance.
initializeParams
:
{
diskSizeGb
:
'10'
,
sourceImage
,
},
autoDelete
:
true
,
boot
:
true
,
type
:
'PERSISTENT'
,
},
],
machineType
:
`zones/
${
zone
}
/machineTypes/
${
machineType
}
`
,
networkInterfaces
:
[
{
// Use the network interface provided in the networkName argument.
name
:
networkName
,
},
],
},
project
:
projectId
,
zone
,
});
let
operation
=
response
.
latestResponse
;
const
operationsClient
=
new
compute
.
ZoneOperationsClient
();
// Wait for the create operation to complete.
while
(
operation
.
status
!==
'DONE'
)
{
[
operation
]
=
await
operationsClient
.
wait
({
operation
:
operation
.
name
,
project
:
projectId
,
zone
:
operation
.
zone
.
split
(
'/'
).
pop
(),
});
}
console
.
log
(
'Instance created.'
);
}
createInstanceWithCustomHostname
();
Python
Before trying this sample, follow the Python setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Python API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
from
__future__
import
annotations
import
re
import
sys
from
typing
import
Any
import
warnings
from
google.api_core.extended_operation
import
ExtendedOperation
from
google.cloud
import
compute_v1
def
get_image_from_family
(
project
:
str
,
family
:
str
)
-
> compute_v1
.
Image
:
"""
Retrieve the newest image that is part of a given family in a project.
Args:
project: project ID or project number of the Cloud project you want to get image from.
family: name of the image family you want to get image from.
Returns:
An Image object.
"""
image_client
=
compute_v1
.
ImagesClient
()
# List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details
newest_image
=
image_client
.
get_from_family
(
project
=
project
,
family
=
family
)
return
newest_image
def
disk_from_image
(
disk_type
:
str
,
disk_size_gb
:
int
,
boot
:
bool
,
source_image
:
str
,
auto_delete
:
bool
=
True
,
)
-
> compute_v1
.
AttachedDisk
:
"""
Create an AttachedDisk object to be used in VM instance creation. Uses an image as the
source for the new disk.
Args:
disk_type: the type of disk you want to create. This value uses the following format:
"zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)".
For example: "zones/us-west3-b/diskTypes/pd-ssd"
disk_size_gb: size of the new disk in gigabytes
boot: boolean flag indicating whether this disk should be used as a boot disk of an instance
source_image: source image to use when creating this disk. You must have read access to this disk. This can be one
of the publicly available images or an image from one of your projects.
This value uses the following format: "projects/{project_name}/global/images/{image_name}"
auto_delete: boolean flag indicating whether this disk should be deleted with the VM that uses it
Returns:
AttachedDisk object configured to be created using the specified image.
"""
boot_disk
=
compute_v1
.
AttachedDisk
()
initialize_params
=
compute_v1
.
AttachedDiskInitializeParams
()
initialize_params
.
source_image
=
source_image
initialize_params
.
disk_size_gb
=
disk_size_gb
initialize_params
.
disk_type
=
disk_type
boot_disk
.
initialize_params
=
initialize_params
# Remember to set auto_delete to True if you want the disk to be deleted when you delete
# your VM instance.
boot_disk
.
auto_delete
=
auto_delete
boot_disk
.
boot
=
boot
return
boot_disk
def
wait_for_extended_operation
(
operation
:
ExtendedOperation
,
verbose_name
:
str
=
"operation"
,
timeout
:
int
=
300
)
-
> Any
:
"""
Waits for the extended (long-running) operation to complete.
If the operation is successful, it will return its result.
If the operation ends with an error, an exception will be raised.
If there were any warnings during the execution of the operation
they will be printed to sys.stderr.
Args:
operation: a long-running operation you want to wait on.
verbose_name: (optional) a more verbose name of the operation,
used only during error and warning reporting.
timeout: how long (in seconds) to wait for operation to finish.
If None, wait indefinitely.
Returns:
Whatever the operation.result() returns.
Raises:
This method will raise the exception received from `operation.exception()`
or RuntimeError if there is no exception set, but there is an `error_code`
set for the `operation`.
In case of an operation taking longer than `timeout` seconds to complete,
a `concurrent.futures.TimeoutError` will be raised.
"""
result
=
operation
.
result
(
timeout
=
timeout
)
if
operation
.
error_code
:
print
(
f
"Error during
{
verbose_name
}
: [Code:
{
operation
.
error_code
}
]:
{
operation
.
error_message
}
"
,
file
=
sys
.
stderr
,
flush
=
True
,
)
print
(
f
"Operation ID:
{
operation
.
name
}
"
,
file
=
sys
.
stderr
,
flush
=
True
)
raise
operation
.
exception
()
or
RuntimeError
(
operation
.
error_message
)
if
operation
.
warnings
:
print
(
f
"Warnings during
{
verbose_name
}
:
\n
"
,
file
=
sys
.
stderr
,
flush
=
True
)
for
warning
in
operation
.
warnings
:
print
(
f
" -
{
warning
.
code
}
:
{
warning
.
message
}
"
,
file
=
sys
.
stderr
,
flush
=
True
)
return
result
def
create_instance
(
project_id
:
str
,
zone
:
str
,
instance_name
:
str
,
disks
:
list
[
compute_v1
.
AttachedDisk
],
machine_type
:
str
=
"n1-standard-1"
,
network_link
:
str
=
"global/networks/default"
,
subnetwork_link
:
str
=
None
,
internal_ip
:
str
=
None
,
external_access
:
bool
=
False
,
external_ipv4
:
str
=
None
,
accelerators
:
list
[
compute_v1
.
AcceleratorConfig
]
=
None
,
preemptible
:
bool
=
False
,
spot
:
bool
=
False
,
instance_termination_action
:
str
=
"STOP"
,
custom_hostname
:
str
=
None
,
delete_protection
:
bool
=
False
,
)
-
> compute_v1
.
Instance
:
"""
Send an instance creation request to the Compute Engine API and wait for it to complete.
Args:
project_id: project ID or project number of the Cloud project you want to use.
zone: name of the zone to create the instance in. For example: "us-west3-b"
instance_name: name of the new virtual machine (VM) instance.
disks: a list of compute_v1.AttachedDisk objects describing the disks
you want to attach to your new instance.
machine_type: machine type of the VM being created. This value uses the
following format: "zones/{zone}/machineTypes/{type_name}".
For example: "zones/europe-west3-c/machineTypes/f1-micro"
network_link: name of the network you want the new instance to use.
For example: "global/networks/default" represents the network
named "default", which is created automatically for each project.
subnetwork_link: name of the subnetwork you want the new instance to use.
This value uses the following format:
"regions/{region}/subnetworks/{subnetwork_name}"
internal_ip: internal IP address you want to assign to the new instance.
By default, a free address from the pool of available internal IP addresses of
used subnet will be used.
external_access: boolean flag indicating if the instance should have an external IPv4
address assigned.
external_ipv4: external IPv4 address to be assigned to this instance. If you specify
an external IP address, it must live in the same region as the zone of the instance.
This setting requires `external_access` to be set to True to work.
accelerators: a list of AcceleratorConfig objects describing the accelerators that will
be attached to the new instance.
preemptible: boolean value indicating if the new instance should be preemptible
or not. Preemptible VMs have been deprecated and you should now use Spot VMs.
spot: boolean value indicating if the new instance should be a Spot VM or not.
instance_termination_action: What action should be taken once a Spot VM is terminated.
Possible values: "STOP", "DELETE"
custom_hostname: Custom hostname of the new VM instance.
Custom hostnames must conform to RFC 1035 requirements for valid hostnames.
delete_protection: boolean value indicating if the new virtual machine should be
protected against deletion or not.
Returns:
Instance object.
"""
instance_client
=
compute_v1
.
InstancesClient
()
# Use the network interface provided in the network_link argument.
network_interface
=
compute_v1
.
NetworkInterface
()
network_interface
.
network
=
network_link
if
subnetwork_link
:
network_interface
.
subnetwork
=
subnetwork_link
if
internal_ip
:
network_interface
.
network_i_p
=
internal_ip
if
external_access
:
access
=
compute_v1
.
AccessConfig
()
access
.
type_
=
compute_v1
.
AccessConfig
.
Type
.
ONE_TO_ONE_NAT
.
name
access
.
name
=
"External NAT"
access
.
network_tier
=
access
.
NetworkTier
.
PREMIUM
.
name
if
external_ipv4
:
access
.
nat_i_p
=
external_ipv4
network_interface
.
access_configs
=
[
access
]
# Collect information into the Instance object.
instance
=
compute_v1
.
Instance
()
instance
.
network_interfaces
=
[
network_interface
]
instance
.
name
=
instance_name
instance
.
disks
=
disks
if
re
.
match
(
r
"^zones/[a-z\d\-]+/machineTypes/[a-z\d\-]+$"
,
machine_type
):
instance
.
machine_type
=
machine_type
else
:
instance
.
machine_type
=
f
"zones/
{
zone
}
/machineTypes/
{
machine_type
}
"
instance
.
scheduling
=
compute_v1
.
Scheduling
()
if
accelerators
:
instance
.
guest_accelerators
=
accelerators
instance
.
scheduling
.
on_host_maintenance
=
(
compute_v1
.
Scheduling
.
OnHostMaintenance
.
TERMINATE
.
name
)
if
preemptible
:
# Set the preemptible setting
warnings
.
warn
(
"Preemptible VMs are being replaced by Spot VMs."
,
DeprecationWarning
)
instance
.
scheduling
=
compute_v1
.
Scheduling
()
instance
.
scheduling
.
preemptible
=
True
if
spot
:
# Set the Spot VM setting
instance
.
scheduling
.
provisioning_model
=
(
compute_v1
.
Scheduling
.
ProvisioningModel
.
SPOT
.
name
)
instance
.
scheduling
.
instance_termination_action
=
instance_termination_action
if
custom_hostname
is
not
None
:
# Set the custom hostname for the instance
instance
.
hostname
=
custom_hostname
if
delete_protection
:
# Set the delete protection bit
instance
.
deletion_protection
=
True
# Prepare the request to insert an instance.
request
=
compute_v1
.
InsertInstanceRequest
()
request
.
zone
=
zone
request
.
project
=
project_id
request
.
instance_resource
=
instance
# Wait for the create operation to complete.
print
(
f
"Creating the
{
instance_name
}
instance in
{
zone
}
..."
)
operation
=
instance_client
.
insert
(
request
=
request
)
wait_for_extended_operation
(
operation
,
"instance creation"
)
print
(
f
"Instance
{
instance_name
}
created."
)
return
instance_client
.
get
(
project
=
project_id
,
zone
=
zone
,
instance
=
instance_name
)
def
create_instance_custom_hostname
(
project_id
:
str
,
zone
:
str
,
instance_name
:
str
,
hostname
:
str
)
-
> compute_v1
.
Instance
:
"""
Create a new VM instance with Debian 10 operating system and a custom hostname.
Args:
project_id: project ID or project number of the Cloud project you want to use.
zone: name of the zone to create the instance in. For example: "us-west3-b"
instance_name: name of the new virtual machine (VM) instance.
hostname: the hostname you want to use for the new instance.
Returns:
Instance object.
"""
newest_debian
=
get_image_from_family
(
project
=
"debian-cloud"
,
family
=
"debian-11"
)
disk_type
=
f
"zones/
{
zone
}
/diskTypes/pd-standard"
disks
=
[
disk_from_image
(
disk_type
,
10
,
True
,
newest_debian
.
self_link
)]
instance
=
create_instance
(
project_id
,
zone
,
instance_name
,
disks
,
custom_hostname
=
hostname
)
return
instance
Terraform
To learn how to apply or remove a Terraform configuration, see Basic Terraform commands . For more information, see the Terraform provider reference documentation .
resource
"google_compute_instance"
"custom_hostname_instance"
{
name
=
"custom-hostname-instance-name"
machine_type
=
"f1-micro"
zone
=
"us-central1-c"
# Set a custom hostname below
hostname
=
"hashicorptest.com"
boot_disk
{
initialize_params
{
image
=
"debian-cloud/debian-11"
}
}
network_interface
{
# A default network is created for all GCP projects
network
=
"default"
access_config
{
}
}
}
What's next
To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .
