kubectl gs

Main page for documentation on kubectl gs, the Giant Swarm kubectl plugin, with an overview of all commans, plus information on how to insstall and upgrade.

kubectl gs plugin reference

kubectl gs 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

Command Description Provider info
login Ensure an authenticated session with a management cluster all providers
get apps List Apps or get details on a single App all providers
get catalogs List Catalogs or get details on a single Catalog all providers
get clusters List clusters or get details on a single cluster only AWS, Azure
get nodepools List node pools or get details on a single node pool only AWS, Azure
get releases List releases or get details on a single release all providers
template app Create manifests for an App all providers
template appcatalog Create manifests for an App Catalog all providers
template cluster Create manifests for a cluster only AWS, Azure
template nodepool Create manifests for a node pool only AWS, Azure
template organization Create manifest for an organization all providers
help Get help for a command provider independent

Installing and updating

With Krew, simply install and upgrade the gs plug-in:

kubectl krew install gs
kubectl krew upgrade gs

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.