Last modified March 2, 2022
kubectl-gs reference
kubectl-gs
is a CLI and a kubectl plugin (invoked as kubectl gs
) for the Giant Swarm Management API.
Note: Management API support is under active development. 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 kubectl context | 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 catalog | Create manifests for a 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 |
update app | Update given App | all providers |
update cluster | Schedule a cluster update | only AWS, Azure |
help | Get help for a command | provider independent |
Deprecated commands:
get appcatalogs
– replaced byget catalogs
template appcatalog
– replaced bytemplate catalog
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.
Troubleshooting
Otherwise, your Giant Swarm support staff is available for you in case you run into an issue. Also feel free to check our frequently asked questions on kubectl-gs
.
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
.
Need help, got feedback?
We listen to your Slack support channel. You can also reach us at support@giantswarm.io. And of course, we welcome your pull requests!