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
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Kubernetes Engine API API.
- Set up authentication so you can access the API from your local workstation. ### Installing the client library
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.
| Sample | Source Code |
|---|---|
| cancel operation | source code |
| check autopilot compatibility | source code |
| complete i p rotation | source code |
| complete node pool upgrade | source code |
| create cluster | source code |
| create node pool | source code |
| delete cluster | source code |
| delete node pool | source code |
| fetch cluster upgrade info | source code |
| fetch node pool upgrade info | source code |
| get cluster | source code |
| get j s o n web keys | source code |
| get node pool | source code |
| get operation | source code |
| get server config | source code |
| list clusters | source code |
| list node pools | source code |
| list operations | source code |
| list usable subnetworks | source code |
| rollback node pool upgrade | source code |
| set addons config | source code |
| set labels | source code |
| set legacy abac | source code |
| set locations | source code |
| set logging service | source code |
| set maintenance policy | source code |
| set master auth | source code |
| set monitoring service | source code |
| set network policy | source code |
| set node pool autoscaling | source code |
| set node pool management | source code |
| set node pool size | source code |
| start i p rotation | source code |
| update cluster | source code |
| update master | source code |
| update node pool | source code |
| container | source code |
| cancel operation | source code |
| check autopilot compatibility | source code |
| complete control plane upgrade | source code |
| complete i p rotation | source code |
| complete node pool upgrade | source code |
| create cluster | source code |
| create node pool | source code |
| delete cluster | source code |
| delete node pool | source code |
| fetch cluster upgrade info | source code |
| fetch node pool upgrade info | source code |
| get cluster | source code |
| get j s o n web keys | source code |
| get node pool | source code |
| get operation | source code |
| get server config | source code |
| list clusters | source code |
| list locations | source code |
| list node pools | source code |
| list operations | source code |
| list usable subnetworks | source code |
| rollback node pool upgrade | source code |
| set addons config | source code |
| set labels | source code |
| set legacy abac | source code |
| set locations | source code |
| set logging service | source code |
| set maintenance policy | source code |
| set master auth | source code |
| set monitoring service | source code |
| set network policy | source code |
| set node pool autoscaling | source code |
| set node pool management | source code |
| set node pool size | source code |
| start i p rotation | source code |
| update cluster | source code |
| update master | source code |
| update node pool | source code |
| container | source 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