Stay organized with collections Save and categorize content based on your preferences.

Kubernetes Engine Cluster Manager API: Node.js Client

release level npm version

Google Container Engine API client for Node.js

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

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

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Kubernetes Engine Cluster Manager API 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/container

Using the client library

async function main() {
  const container = require('@google-cloud/container');

  // Create the Cluster Manager Client
  const client = new container.v1.ClusterManagerClient();

  async function quickstart() {
    const zone = 'us-central1-a';
    const projectId = await client.getProjectId();
    const request = {
      projectId: projectId,
      zone: zone,
    };

    const [response] = await client.listClusters(request);
    console.log('Clusters: ', response);
  }
  quickstart();
}

main().catch(console.error);

Samples

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

SampleSource CodeTry it
Cluster_manager.cancel_operationsource codeOpen in Cloud Shell
Cluster_manager.complete_i_p_rotationsource codeOpen in Cloud Shell
Cluster_manager.complete_node_pool_upgradesource codeOpen in Cloud Shell
Cluster_manager.create_clustersource codeOpen in Cloud Shell
Cluster_manager.create_node_poolsource codeOpen in Cloud Shell
Cluster_manager.delete_clustersource codeOpen in Cloud Shell
Cluster_manager.delete_node_poolsource codeOpen in Cloud Shell
Cluster_manager.get_clustersource codeOpen in Cloud Shell
Cluster_manager.get_j_s_o_n_web_keyssource codeOpen in Cloud Shell
Cluster_manager.get_node_poolsource codeOpen in Cloud Shell
Cluster_manager.get_operationsource codeOpen in Cloud Shell
Cluster_manager.get_server_configsource codeOpen in Cloud Shell
Cluster_manager.list_clusterssource codeOpen in Cloud Shell
Cluster_manager.list_node_poolssource codeOpen in Cloud Shell
Cluster_manager.list_operationssource codeOpen in Cloud Shell
Cluster_manager.list_usable_subnetworkssource codeOpen in Cloud Shell
Cluster_manager.rollback_node_pool_upgradesource codeOpen in Cloud Shell
Cluster_manager.set_addons_configsource codeOpen in Cloud Shell
Cluster_manager.set_labelssource codeOpen in Cloud Shell
Cluster_manager.set_legacy_abacsource codeOpen in Cloud Shell
Cluster_manager.set_locationssource codeOpen in Cloud Shell
Cluster_manager.set_logging_servicesource codeOpen in Cloud Shell
Cluster_manager.set_maintenance_policysource codeOpen in Cloud Shell
Cluster_manager.set_master_authsource codeOpen in Cloud Shell
Cluster_manager.set_monitoring_servicesource codeOpen in Cloud Shell
Cluster_manager.set_network_policysource codeOpen in Cloud Shell
Cluster_manager.set_node_pool_autoscalingsource codeOpen in Cloud Shell
Cluster_manager.set_node_pool_managementsource codeOpen in Cloud Shell
Cluster_manager.set_node_pool_sizesource codeOpen in Cloud Shell
Cluster_manager.start_i_p_rotationsource codeOpen in Cloud Shell
Cluster_manager.update_clustersource codeOpen in Cloud Shell
Cluster_manager.update_mastersource codeOpen in Cloud Shell
Cluster_manager.update_node_poolsource codeOpen in Cloud Shell
Cluster_manager.cancel_operationsource codeOpen in Cloud Shell
Cluster_manager.complete_i_p_rotationsource codeOpen in Cloud Shell
Cluster_manager.complete_node_pool_upgradesource codeOpen in Cloud Shell
Cluster_manager.create_clustersource codeOpen in Cloud Shell
Cluster_manager.create_node_poolsource codeOpen in Cloud Shell
Cluster_manager.delete_clustersource codeOpen in Cloud Shell
Cluster_manager.delete_node_poolsource codeOpen in Cloud Shell
Cluster_manager.get_clustersource codeOpen in Cloud Shell
Cluster_manager.get_j_s_o_n_web_keyssource codeOpen in Cloud Shell
Cluster_manager.get_node_poolsource codeOpen in Cloud Shell
Cluster_manager.get_operationsource codeOpen in Cloud Shell
Cluster_manager.get_server_configsource codeOpen in Cloud Shell
Cluster_manager.list_clusterssource codeOpen in Cloud Shell
Cluster_manager.list_locationssource codeOpen in Cloud Shell
Cluster_manager.list_node_poolssource codeOpen in Cloud Shell
Cluster_manager.list_operationssource codeOpen in Cloud Shell
Cluster_manager.list_usable_subnetworkssource codeOpen in Cloud Shell
Cluster_manager.rollback_node_pool_upgradesource codeOpen in Cloud Shell
Cluster_manager.set_addons_configsource codeOpen in Cloud Shell
Cluster_manager.set_labelssource codeOpen in Cloud Shell
Cluster_manager.set_legacy_abacsource codeOpen in Cloud Shell
Cluster_manager.set_locationssource codeOpen in Cloud Shell
Cluster_manager.set_logging_servicesource codeOpen in Cloud Shell
Cluster_manager.set_maintenance_policysource codeOpen in Cloud Shell
Cluster_manager.set_master_authsource codeOpen in Cloud Shell
Cluster_manager.set_monitoring_servicesource codeOpen in Cloud Shell
Cluster_manager.set_network_policysource codeOpen in Cloud Shell
Cluster_manager.set_node_pool_autoscalingsource codeOpen in Cloud Shell
Cluster_manager.set_node_pool_managementsource codeOpen in Cloud Shell
Cluster_manager.set_node_pool_sizesource codeOpen in Cloud Shell
Cluster_manager.start_i_p_rotationsource codeOpen in Cloud Shell
Cluster_manager.update_clustersource codeOpen in Cloud Shell
Cluster_manager.update_mastersource codeOpen in Cloud Shell
Cluster_manager.update_node_poolsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstart.testsource codeOpen in Cloud Shell

The Kubernetes Engine Cluster Manager API 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/container@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