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
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
Before you begin
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Google Compute Engine API.
- 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 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 Instance||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|
|Reset Instance||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
npm install @google-cloud/compute@legacy-8 installs client libraries
for versions compatible with Node.js 8.
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
Contributions welcome! See the Contributing Guide.
Please note that this
and a variety of configuration files in this repository (including
are generated from a central template. To edit one of these files, make an edit
to its templates in
Apache Version 2.0