@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 Compute Engine: Node.js Client

Google Compute Engine Client Library for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

• Google Compute Engine Node.js Client API Reference
• Google Compute Engine Documentation
• github.com/googleapis/nodejs-compute

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Google Compute Engine API.
4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/compute

Using the client library

// Imports the Google Cloud client library
const Compute = require('@google-cloud/compute');

// Creates a client
const compute = new Compute();

async function quickstart() {
  // Create a new VM using the latest OS image of your choice.
  const zone = compute.zone('us-central1-c');

  // TODO(developer): choose a name for the VM
  // const vmName = 'vm-name';

  // Start the VM create task
  const [vm, operation] = await zone.createVM(vmName, {os: 'ubuntu'});
  console.log(vm);

  // `operation` lets you check the status of long-running tasks.
  await operation.promise();

  // Complete!
  console.log('Virtual machine created!');
}
quickstart();

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample	Source Code	Try it
Create VM	source code
Delete VM	source code
List VMs	source code
Mailjet	source code
Quickstart	source code
Sendgrid	source code
Startup Script	source code
Vms	source code

The Google Compute Engine Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targetting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

• Legacy versions will not be tested in continuous integration.
• Some security patches may not be able to be backported.
• Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

• legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be in alpha. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its template in this directory.

License

Apache Version 2.0

See LICENSE