Documentation on gsctl, the Giant Swarm command line utility to create and delete clusters, create key pairs and more.
The Giant Swarm On Premises Architecture
Architecture overview showing how Giant Swarm is set up within a customer data center on bare metal or virtual machines.
The Giant Swarm AWS Architecture
Architecture Overview showing how Giant Swarm is set up on Amazon Web Services
Cluster Definition YAML Reference
Complete documentation of the Giant Swarm cluster definition YAML format
Documentation of the Giant Swarm cluster security
Global command line options in gsctl
Documentation for gsctl options that can be passed on the command line for almost all commands. Plus some tips on how you can use them to switch environments.
gsctl Command Reference: create cluster
Detailed documentation on how to create a new cluster using the 'create cluster' command in gsctl.
gsctl Command Reference: create kubeconfig
The 'gsctl create kubeconfig' command creates a key pair and adds cluster, user, and context settings to your kubectl configuration.
gsctl Command Reference: create keypair
The 'gsctl create keypair' command creates a key pair and stores the related files in your certificate folder.
gsctl Command Reference: info
The 'gsctl info' lets you display information on your current status and configuration
gsctl Command Reference: list endpoints
The 'gsctl list endpoints' command shows all endpoints you have logged in to so far and tells you which one is currently selected.
gsctl Command Reference: select endpoint
The 'gsctl select endpoint' command selects an endpoint for usage in subsequent command executions.
gsctl Command Reference: login
The 'gsctl login' command starts an authenticated session.
gsctl Command Reference: list releases
The 'gsctl list releases' command shows all releases available in an installation.
gsctl command Reference: delete cluster
Detailed documentation on how to delete a cluster using the 'delete cluster' command in gsctl.
gsctl Command Reference: list clusters
The 'gsctl list clusters' command shows all clusters you have access to with a few details like cluster ID, name, creation date, and owner organization.
gsctl Command Reference: show cluster
The 'gsctl show cluster' command displays details of a cluster.
gsctl Command Reference: scale cluster
The 'gsctl scale cluster' command allows to add or remove worker nodes to reach a desired number.
Installation documentation for kubectl, the Kubernetes command line interface.
gsctl Reference: Configuration file
Documentation of the configuration file format of gsctl