Last modified September 15, 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 organizations`	List organizations or get details on a single organization	all providers
`get releases`	List releases or get details on a single release	all providers
`gitops`	Gathers GitOps related subcommand	N/A
`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 by get catalogs
template appcatalog – replaced by template catalog

Flags

Name	Description
`--v`, `--version`	Version for kubectl gs.

Global flags

Name	Description
`--as`	Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
`--as-group`	Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
`--as-uid`	UID to impersonate for the operation.
`--cache-dir`	Default cache directory.
`--certificate-authority`	Path to a cert file for the certificate authority.
`--client-certificate`	Path to a client certificate file for TLS.
`--client-key`	Path to a client key file for TLS.
`--cluster`	The name of the kubeconfig cluster to use.
`--context`	The name of the kubeconfig context to use.
`--debug`	Toggle debug mode, for seeing full error output.
`--disable-version-check`	Disable self-update version check.
`-h`, `--help`	Help for kubectl gs.
`--insecure-skip-tls-verify`	If true, the server’s certificate will not be checked for validity. This will make your HTTPS connections insecure.
`--kubeconfig`	Path to the kubeconfig file to use for CLI requests.
`-n`, `--namespace`	If present, the namespace scope for this CLI request.
`--request-timeout`	The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don’t timeout requests. (default “0”)
`-s`, `--server`	The address and port of the Kubernetes API server
`--tls-server-name`	Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
`--token`	Bearer token for authentication to the API server
`--user`	The name of the kubeconfig user to use

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!