@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

Node.js idiomatic client for Compute Engine. Compute Engine is a computing and hosting service that lets you create and run virtual machines on Google infrastructure. Compute Engine offers scale, performance, and value that lets you easily launch large compute clusters on Google's infrastructure. There are no upfront investments, and you can run thousands of virtual CPUs on a system that offers quick, consistent performance.

This library is GA from version 3.1.0. It is backwards-incompatible with prior versions 0.x.y, 1.x.y, 2.x.y, and 3.0.y.

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

• 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

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Create Instance	source code
Create Instance From Template	source code
Create Instance From Template With Overrides	source code
Delete Instance	source code
Disable Usage Export	source code
Get Usage Export Bucket	source code
List All Instances	source code
List Images	source code
List Images By Page	source code
List Instances	source code
Mailjet	source code
Reset Instance	source code
Sendgrid	source code
Set Usage Export Bucket	source code
Start Instance	source code
Start Instance With Enc Key	source code
Stop Instance	source code
Wait For Operation	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. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/compute@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

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 templates in directory.

License

Apache Version 2.0

See LICENSE