@google-cloud/compute

What is @google-cloud/compute?

@google-cloud/compute is an npm package that provides a client library for interacting with Google Cloud Compute Engine. It allows developers to manage virtual machine instances, networks, firewalls, and other resources on Google Cloud Platform (GCP).

What are @google-cloud/compute's main functionalities?

Create a VM instance

This code sample demonstrates how to create a new VM instance in Google Cloud Compute Engine using the @google-cloud/compute package.

const {InstancesClient} = require('@google-cloud/compute');
const compute = new InstancesClient();

async function createInstance() {
  const [response] = await compute.insert({
    project: 'your-project-id',
    zone: 'us-central1-a',
    instanceResource: {
      name: 'instance-name',
      machineType: 'zones/us-central1-a/machineTypes/n1-standard-1',
      disks: [
        {
          boot: true,
          initializeParams: {
            sourceImage: 'projects/debian-cloud/global/images/family/debian-10'
          }
        }
      ],
      networkInterfaces: [
        {
          network: 'global/networks/default'
        }
      ]
    }
  });
  console.log('Instance created:', response);
}

createInstance().catch(console.error);

List VM instances

This code sample demonstrates how to list all VM instances in a specific zone using the @google-cloud/compute package.

const {InstancesClient} = require('@google-cloud/compute');
const compute = new InstancesClient();

async function listInstances() {
  const [instances] = await compute.list({
    project: 'your-project-id',
    zone: 'us-central1-a'
  });
  console.log('Instances:', instances);
}

listInstances().catch(console.error);

Delete a VM instance

This code sample demonstrates how to delete a VM instance in Google Cloud Compute Engine using the @google-cloud/compute package.

const {InstancesClient} = require('@google-cloud/compute');
const compute = new InstancesClient();

async function deleteInstance() {
  const [response] = await compute.delete({
    project: 'your-project-id',
    zone: 'us-central1-a',
    instance: 'instance-name'
  });
  console.log('Instance deleted:', response);
}

deleteInstance().catch(console.error);

Other packages similar to @google-cloud/compute

aws-sdk

The aws-sdk package is the official AWS SDK for JavaScript, which allows developers to interact with various AWS services, including EC2 for managing virtual machine instances. It provides similar functionalities to @google-cloud/compute but for Amazon Web Services.

azure-arm-compute

The azure-arm-compute package is the Azure SDK for managing compute resources in Microsoft Azure. It provides functionalities to manage virtual machines, disks, and other compute resources on Azure, similar to what @google-cloud/compute offers for Google Cloud Platform.

README

@google-cloud/compute

Google Compute Engine Client Library for Node.js

Looking for more Google APIs than just Compute Engine? You might want to check out google-cloud.

• API Documentation
• Official Documentation

$ npm install --save @google-cloud/compute

var gce = require('@google-cloud/compute')({
  projectId: 'grape-spaceship-123',
  keyFilename: '/path/to/keyfile.json'
});

// Create a new VM using the latest OS image of your choice.
var zone = gce.zone('us-central1-a');
var name = 'ubuntu-http';

zone.createVM(name, { os: 'ubuntu' }, function(err, vm, operation) {
  // `operation` lets you check the status of long-running tasks.

  operation
    .on('error', function(err) {})
    .on('running', function(metadata) {})
    .on('complete', function() {
      // Virtual machine created!
    });
});

// Promises are also supported by omitting callbacks.
zone.createVM(name)
  .then(function(data) {
    var vm = data[0];
    var operation = data[1];

    return operation.promise();
  })
  .then(function() {
    // Virtual machine created!
  });

// It's also possible to integrate with third-party Promise libraries.
var gce = require('@google-cloud/compute')({
  promise: require('bluebird')
});

Authentication

It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services.

On Google Compute Engine

If you are running this client on Google Compute Engine, we handle authentication for you with no configuration. You just need to make sure that when you set up the GCE instance, you add the correct scopes for the APIs you want to access.

// Authenticating on a global basis.
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'

var gce = require('@google-cloud/compute')({
  projectId: projectId
});

// ...you're good to go!

Elsewhere

If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account:

1. Visit the Google Developers Console.
2. Create a new project or click on an existing project.
3. Navigate to APIs & auth > APIs section and turn on the following APIs (you may need to enable billing in order to use these services):

• Google Compute Engine API

1. Navigate to APIs & auth > Credentials and then:

• If you want to use a new service account key, click on Create credentials and select Service account key. After the account key is created, you will be prompted to download the JSON key file that the library uses to authenticate your requests.
• If you want to generate a new service account key for an existing service account, click on Generate new JSON key and download the JSON key file.

var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'

var gce = require('@google-cloud/compute')({
  projectId: projectId,

  // The path to your key file:
  keyFilename: '/path/to/keyfile.json'

  // Or the contents of the key file:
  credentials: require('./path/to/keyfile.json')
});

// ...you're good to go!