The Giant Swarm command line interface
Clone or download
marians Fix download URL for homebrew and scoop (#323)
* Fix download URL for homebrew

* Fix download URLs for scoop
Latest commit 21c5661 Dec 10, 2018

README.md

codecov Go Report Card IRC Channel

gsctl - The Giant Swarm CLI

gsctl is the cross-platform command line utility to manage your Kubernetes clusters at Giant Swarm.

Usage

Call gsctl without any arguments to get an overview on commands. Some usage examples:

Log in using your Giant Swarm credentials

$ gsctl login demo@example.com -e <giant-swarm-api-endpoint>
Password for demo@example.com at <giant-swarm-api-endpoint>:
Successfully logged in!

Show your clusters

$ 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

Create a cluster

$ 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

Configure kubectl to access a cluster

$ 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

Install

See the gsctl reference docs

Configuration

See the gsctl reference docs

Changelog

See Releases

Development

See docs/Development.md

Contributing

We welcome contributions! Please read our additional information on how to contribute for details.

Publishing a Release

See docs/Release.md