gsctl and the REST API are being phased out. We recommend to familiarize yourself with our Management API and the kubectl gs plugin as a future-proof replacement.
For customers still using the Giant Swarm REST API, gsctl is a cross-platform command line utility to manage clusters.
Call gsctl without any arguments to get an overview on commands. Some usage examples:
$ gsctl login demo@example.com -e <giant-swarm-api-endpoint>
Password for demo@example.com at <giant-swarm-api-endpoint>:
Successfully logged in!
$ gsctl list clusters
ID NAME CREATED ORGANIZATION
9gxjo Production Cluster 2016 Apr 30, 15:43 UTC acme
xl8t1 Staging Cluster 2017 May 11, 09:30 UTC acme
$ gsctl create cluster --owner acme --name "Test Cluster" --num-workers 5
Requesting new cluster for organization 'acme'
New cluster with ID 'h8d0j' is launching.
More in the docs
$ gsctl create kubeconfig -c h8d0j
Creating new key pair…
New key pair created with ID 153a93201… and expiry of 720 hours
Certificate and key files written to:
/Users/demo/.config/gsctl/certs/h8d0j-ca.crt
/Users/demo/.config/gsctl/certs/h8d0j-153a932010-client.crt
/Users/demo/.config/gsctl/certs/h8d0j-153a932010-client.key
Switched to kubectl context 'giantswarm-xl8t1'
kubectl is set up. Check it using this command:
kubectl cluster-info
Whenever you want to switch to using this context:
kubectl config use-context giantswarm-xl8t1
Note: You can launch the context using Kubie by using --kubie switch
The internal Kubernetes API endpoint allows you to talk to Kubernetes via the internal load balancer. That can be useful for peered networks.
In case you want to use the internal Kubernetes API, pass --internal-api=true to gsctl when creating a kubectl config entry:
gsctl create kubeconfig -c h8d0j --internal-api=true
This will render a kubeconfig with the internal Kubernetes API host name internal-api, resolving to the internal load balancer.
Note: The internal API endpoint is available only on AWS installations.
See the gsctl reference docs
See the gsctl reference docs
See Releases
We welcome contributions! Please read our additional information on how to contribute for details.
See docs/Release.md