Google Cloud Platform logo

Kubernetes Engine Cluster Manager API: Node.js Client

release level npm version codecov

Node.js idiomatic client for Kubernetes Engine cluster management.

Kubernetes Engine is used for building and managing container based applications, powered by the open source Kubernetes technology.

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

  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:');
    console.log(response);
  }
  quickstart();

Relationship to Kubernetes

@google-cloud/container provides a high level API for creating and managing Google Kubernetes Engine clusters on Google Cloud.

To run commands against the clusters created, you will need to use the Kubernetes API (and the associated kubectl command-line interface).

Samples

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

Sample Source Code Try it
Quickstart source code Open in Cloud Shell

The Kubernetes Engine Cluster Manager API Node.js Client API Reference documentation also contains samples.

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.

License

Apache Version 2.0

See LICENSE