Skip to main content

VM Instance

Provides a Virtual Machine instance.

Examples#

Simple VM#

const server = provider.compute.makeVmInstance({
name: "web-server",
properties: () => ({
diskSizeGb: "20",
machineType: "f1-micro",
sourceImage:
"projects/ubuntu-os-cloud/global/images/family/ubuntu-2004-lts",
metadata: {
items: [
{
key: "enable-oslogin",
value: "True",
},
],
},
}),
});

To list the available source image:

gcloud compute images list

Attach a public IP address#

const ip = provider.compute.makeAddress({
name: `ip-webserver`,
});
const server = provider.compute.makeVmInstance({
name: `webserver`,
dependencies: { ip },
properties: () => ({
diskSizeGb: "20",
machineType: "f1-micro",
sourceImage:
"projects/ubuntu-os-cloud/global/images/family/ubuntu-2004-lts",
metadata: {
items: [
{
key: "enable-oslogin",
value: "True",
},
],
},
}),
});

Attach a service account#

const serviceAccount = provider.iam.makeServiceAccount({
name: `sa-dev`,
properties: () => ({
serviceAccount: {
displayName: "SA dev",
},
}),
});
// Allocate a server
const server = provider.compute.makeVmInstance({
name: `webserver`,
dependencies: { serviceAccount },
properties: () => ({
diskSizeGb: "20",
machineType: "f1-micro",
sourceImage:
"projects/ubuntu-os-cloud/global/images/family/ubuntu-2004-lts",
metadata: {
items: [
{
key: "enable-oslogin",
value: "True",
},
],
},
}),
});

Authenticate with a local SSH key pair#

const publicKey = fs.readFileSync(
path.resolve(process.env.HOME, ".ssh/id_rsa.pub")
);
const ip = provider.compute.makeAddress({
name: `ip-webserver-ssh-keys`,
});
const firewall22 = provider.compute.makeFirewall({
name: `firewall-22`,
properties: () => ({
allowed: [
{
IPProtocol: "tcp",
ports: ["22"],
},
],
}),
});
const server = provider.compute.makeVmInstance({
name: `webserver-ssh-keys`,
dependencies: { ip },
properties: () => ({
diskSizeGb: "20",
machineType: "f1-micro",
sourceImage:
"projects/ubuntu-os-cloud/global/images/family/ubuntu-2004-lts",
metadata: {
items: [
{
key: "ssh-keys",
value: `ubuntu:${publicKey}`,
},
],
},
}),
});

Authenticate with oslogin#

const server = provider.compute.makeVmInstance({
name: `webserver`,
properties: () => ({
diskSizeGb: "20",
machineType: "f1-micro",
sourceImage:
"projects/ubuntu-os-cloud/global/images/family/ubuntu-2004-lts",
metadata: {
items: [
{
key: "enable-oslogin",
value: "True",
},
],
},
}),
});

VM Intance into a specific network#

// Vpc network
const network = provider.compute.makeNetwork({
name: `vpc`,
properties: () => ({ autoCreateSubnetworks: false }),
});
// Subnetwork
const subNetwork = provider.ec2.makeSubnetwork({
name: `subnetwork`,
dependencies: { network },
properties: () => ({
ipCidrRange: "10.164.0.0/20",
}),
});
// Allocate a server
const server = provider.compute.makeVmInstance({
name: `my-server`,
dependencies: { subNetwork },
properties: () => ({
sourceImage:
"projects/ubuntu-os-cloud/global/images/family/ubuntu-2004-lts",
}),
});

Examples Code#

Properties#

Dependencies#