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 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.

Sample Source Code Try it
Cluster_manager.cancel_operation
source code Open in Cloud Shell
Cluster_manager.check_autopilot_compatibility
source code Open in Cloud Shell
Cluster_manager.complete_i_p_rotation
source code Open in Cloud Shell
Cluster_manager.complete_node_pool_upgrade
source code Open in Cloud Shell
Cluster_manager.create_cluster
source code Open in Cloud Shell
Cluster_manager.create_node_pool
source code Open in Cloud Shell
Cluster_manager.delete_cluster
source code Open in Cloud Shell
Cluster_manager.delete_node_pool
source code Open in Cloud Shell
Cluster_manager.get_cluster
source code Open in Cloud Shell
Cluster_manager.get_j_s_o_n_web_keys
source code Open in Cloud Shell
Cluster_manager.get_node_pool
source code Open in Cloud Shell
Cluster_manager.get_operation
source code Open in Cloud Shell
Cluster_manager.get_server_config
source code Open in Cloud Shell
Cluster_manager.list_clusters
source code Open in Cloud Shell
Cluster_manager.list_node_pools
source code Open in Cloud Shell
Cluster_manager.list_operations
source code Open in Cloud Shell
Cluster_manager.list_usable_subnetworks
source code Open in Cloud Shell
Cluster_manager.rollback_node_pool_upgrade
source code Open in Cloud Shell
Cluster_manager.set_addons_config
source code Open in Cloud Shell
Cluster_manager.set_labels
source code Open in Cloud Shell
Cluster_manager.set_legacy_abac
source code Open in Cloud Shell
Cluster_manager.set_locations
source code Open in Cloud Shell
Cluster_manager.set_logging_service
source code Open in Cloud Shell
Cluster_manager.set_maintenance_policy
source code Open in Cloud Shell
Cluster_manager.set_master_auth
source code Open in Cloud Shell
Cluster_manager.set_monitoring_service
source code Open in Cloud Shell
Cluster_manager.set_network_policy
source code Open in Cloud Shell
Cluster_manager.set_node_pool_autoscaling
source code Open in Cloud Shell
Cluster_manager.set_node_pool_management
source code Open in Cloud Shell
Cluster_manager.set_node_pool_size
source code Open in Cloud Shell
Cluster_manager.start_i_p_rotation
source code Open in Cloud Shell
Cluster_manager.update_cluster
source code Open in Cloud Shell
Cluster_manager.update_master
source code Open in Cloud Shell
Cluster_manager.update_node_pool
source code Open in Cloud Shell
Cluster_manager.cancel_operation
source code Open in Cloud Shell
Cluster_manager.check_autopilot_compatibility
source code Open in Cloud Shell
Cluster_manager.complete_i_p_rotation
source code Open in Cloud Shell
Cluster_manager.complete_node_pool_upgrade
source code Open in Cloud Shell
Cluster_manager.create_cluster
source code Open in Cloud Shell
Cluster_manager.create_node_pool
source code Open in Cloud Shell
Cluster_manager.delete_cluster
source code Open in Cloud Shell
Cluster_manager.delete_node_pool
source code Open in Cloud Shell
Cluster_manager.get_cluster
source code Open in Cloud Shell
Cluster_manager.get_j_s_o_n_web_keys
source code Open in Cloud Shell
Cluster_manager.get_node_pool
source code Open in Cloud Shell
Cluster_manager.get_operation
source code Open in Cloud Shell
Cluster_manager.get_server_config
source code Open in Cloud Shell
Cluster_manager.list_clusters
source code Open in Cloud Shell
Cluster_manager.list_locations
source code Open in Cloud Shell
Cluster_manager.list_node_pools
source code Open in Cloud Shell
Cluster_manager.list_operations
source code Open in Cloud Shell
Cluster_manager.list_usable_subnetworks
source code Open in Cloud Shell
Cluster_manager.rollback_node_pool_upgrade
source code Open in Cloud Shell
Cluster_manager.set_addons_config
source code Open in Cloud Shell
Cluster_manager.set_labels
source code Open in Cloud Shell
Cluster_manager.set_legacy_abac
source code Open in Cloud Shell
Cluster_manager.set_locations
source code Open in Cloud Shell
Cluster_manager.set_logging_service
source code Open in Cloud Shell
Cluster_manager.set_maintenance_policy
source code Open in Cloud Shell
Cluster_manager.set_master_auth
source code Open in Cloud Shell
Cluster_manager.set_monitoring_service
source code Open in Cloud Shell
Cluster_manager.set_network_policy
source code Open in Cloud Shell
Cluster_manager.set_node_pool_autoscaling
source code Open in Cloud Shell
Cluster_manager.set_node_pool_management
source code Open in Cloud Shell
Cluster_manager.set_node_pool_size
source code Open in Cloud Shell
Cluster_manager.start_i_p_rotation
source code Open in Cloud Shell
Cluster_manager.update_cluster
source code Open in Cloud Shell
Cluster_manager.update_master
source code Open in Cloud Shell
Cluster_manager.update_node_pool
source code Open in Cloud Shell
Quickstart
source code Open 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 stablelibraries 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

Design a Mobile Site
View Site in Mobile | Classic
Share by: