Last modified January 18, 2021

kubectl gs plugin reference

kubectl gs, also known as kgs, is a kubectl plugin for the Giant Swarm Management API.

Note that Management API access is currently in a preview stage. Supported functionality depends on the provider and the workload cluster release used. Please pay attention to the compatibility information given on the individual command reference pages.

Commands

CommandDescriptionProvider info
loginEnsure an authenticated session with a management clusterall providers
get clustersList clusters or get details on a single clusteronly AWS, Azure
get nodepoolsList node pools or get details on a single node poolonly AWS, Azure
template appCreate manifests for an Appall providers
template appcatalogCreate manifests for an AppCatalogall providers
template clusterCreate manifests for a clusteronly AWS, Azure
template nodepoolCreate manifests for a node poolonly AWS, Azure
helpGet help for a commandprovider independent

Installing and updating

With Krew installed, here is a synopsis:

kubectl krew install gs
alias kgs="kubectl gs"
kgs

Find out more details in our installation docs.

Contributing

See the GitHub project for source code, issues and pull requests.

As a Giant Swarm customer, feel free to use your Slack channel to give feedback, ask questions and suggest improvements for kubectl gs.