Back to Google Cloud Node

[Kubernetes Engine API: Nodejs Client][homepage]

packages/google-container/README.md

0.57.019.0 KB
Original Source

Kubernetes Engine API: Nodejs Client

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

Kubernetes Engine API client for Node.js

Node.js idiomatic client for [Kubernetes Engine][product-docs] 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.

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 API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

bash
npm install @google-cloud/container

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.

SampleSource Code
cancel operationsource code
check autopilot compatibilitysource code
complete i p rotationsource code
complete node pool upgradesource code
create clustersource code
create node poolsource code
delete clustersource code
delete node poolsource code
fetch cluster upgrade infosource code
fetch node pool upgrade infosource code
get clustersource code
get j s o n web keyssource code
get node poolsource code
get operationsource code
get server configsource code
list clusterssource code
list node poolssource code
list operationssource code
list usable subnetworkssource code
rollback node pool upgradesource code
set addons configsource code
set labelssource code
set legacy abacsource code
set locationssource code
set logging servicesource code
set maintenance policysource code
set master authsource code
set monitoring servicesource code
set network policysource code
set node pool autoscalingsource code
set node pool managementsource code
set node pool sizesource code
start i p rotationsource code
update clustersource code
update mastersource code
update node poolsource code
containersource code
cancel operationsource code
check autopilot compatibilitysource code
complete control plane upgradesource code
complete i p rotationsource code
complete node pool upgradesource code
create clustersource code
create node poolsource code
delete clustersource code
delete node poolsource code
fetch cluster upgrade infosource code
fetch node pool upgrade infosource code
get clustersource code
get j s o n web keyssource code
get node poolsource code
get operationsource code
get server configsource code
list clusterssource code
list locationssource code
list node poolssource code
list operationssource code
list usable subnetworkssource code
rollback node pool upgradesource code
set addons configsource code
set labelssource code
set legacy abacsource code
set locationssource code
set logging servicesource code
set maintenance policysource code
set master authsource code
set monitoring servicesource code
set network policysource code
set node pool autoscalingsource code
set node pool managementsource code
set node pool sizesource code
start i p rotationsource code
update clustersource code
update mastersource code
update node poolsource code
containersource code

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE