@google-cloud/container

What is @google-cloud/container?

@google-cloud/container is a Node.js client library for Google Kubernetes Engine (GKE). It allows developers to interact with GKE clusters programmatically, enabling operations such as creating, managing, and deleting clusters, as well as retrieving information about clusters and their nodes.

What are @google-cloud/container's main functionalities?

Create a Cluster

This feature allows you to create a new Kubernetes cluster in GKE. The code sample demonstrates how to use the @google-cloud/container package to create a cluster with a specified name, initial node count, and node configuration.

const {ClusterManagerClient} = require('@google-cloud/container');
const client = new ClusterManagerClient();

async function createCluster() {
  const request = {
    parent: 'projects/YOUR_PROJECT_ID/locations/YOUR_LOCATION',
    cluster: {
      name: 'my-cluster',
      initialNodeCount: 3,
      nodeConfig: {
        machineType: 'n1-standard-1'
      }
    }
  };
  const [operation] = await client.createCluster(request);
  console.log('Cluster creation operation:', operation);
}

createCluster().catch(console.error);

List Clusters

This feature allows you to list all the Kubernetes clusters in a specified project and location. The code sample demonstrates how to use the @google-cloud/container package to retrieve and print the list of clusters.

const {ClusterManagerClient} = require('@google-cloud/container');
const client = new ClusterManagerClient();

async function listClusters() {
  const request = {
    parent: 'projects/YOUR_PROJECT_ID/locations/YOUR_LOCATION'
  };
  const [response] = await client.listClusters(request);
  console.log('Clusters:', response.clusters);
}

listClusters().catch(console.error);

Delete a Cluster

This feature allows you to delete an existing Kubernetes cluster in GKE. The code sample demonstrates how to use the @google-cloud/container package to delete a cluster by specifying its name.

const {ClusterManagerClient} = require('@google-cloud/container');
const client = new ClusterManagerClient();

async function deleteCluster() {
  const request = {
    name: 'projects/YOUR_PROJECT_ID/locations/YOUR_LOCATION/clusters/YOUR_CLUSTER_NAME'
  };
  const [operation] = await client.deleteCluster(request);
  console.log('Cluster deletion operation:', operation);
}

deleteCluster().catch(console.error);

Other packages similar to @google-cloud/container

kubernetes-client

The kubernetes-client package is a Node.js client for the Kubernetes API. It provides a way to interact with Kubernetes clusters, including creating, updating, and deleting resources such as pods, services, and deployments. Compared to @google-cloud/container, kubernetes-client is more general-purpose and can be used with any Kubernetes cluster, not just GKE.

k8s

The k8s package is another Node.js client for the Kubernetes API. It offers a simple and flexible way to manage Kubernetes resources programmatically. Like kubernetes-client, it is not specific to GKE and can be used with any Kubernetes cluster. It provides similar functionalities to @google-cloud/container but with a broader scope.

README

Kubernetes Engine Cluster Manager API: Node.js Client

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.

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

• Kubernetes Engine Cluster Manager API Node.js Client API Reference
• Kubernetes Engine Cluster Manager API Documentation
• github.com/googleapis/nodejs-cloud-container

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
  • Using 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 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);

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. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Create_cluster	source code
Delete_cluster	source code
Quickstart	source code

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