nodepools

Documentation

Overview

Package nodepools implements the 'list nodepools' sub-command.

Index

• Variables
• type Arguments

Variables

var (
	// Command performs the "list nodepools" function
	Command = &cobra.Command{
		Use:     "nodepools <cluster-name/cluster-id>",
		Aliases: []string{"nps", "np"},

		Args:  cobra.ExactArgs(1),
		Short: "List node pools",
		Long: `Prints a list of the node pools of a cluster.

The result will be a table of all node pools of a specific cluster with the following details in
columns:

	ID:                    Node pool identifier (unique within the cluster)
	NAME:                  Name specified for the node pool, usually indicating the purpose
	AZ:                    Availability zone letters used by the node pool, separated by comma
	INSTANCE TYPES:        EC2 instance types used for worker nodes
	ALIKE:                 If similar instance types are allowed in your node pool. This list is maintained by Giant Swarm at the moment. Eg if you select m5.xlarge then the node pool can fall back on m4.xlarge too
	ON-DEMAND BASE:        Number of on-demand instances that this node pool needs to have until spot instances are used. (AWS only)
	SPOT PERCENTAGE:       Percentage of spot instances used once the on-demand base capacity is fullfilled. A number of 40 means that 60% will be on-demand and 40% will be spot instances. (AWS only)
	NODES MIN/MAX:         The minimum and maximum number of worker nodes in this pool
	NODES DESIRED:         Current desired number of nodes as determined by the autoscaler
	NODES READY:           Number of nodes that are in the Ready state in kubernetes
	SPOT INSTANCES COUNT:  Number of spot instances in this node pool (AWS ony)
	SPOT INSTANCES:        Whether spot instances are used or not (Azure only)
	CPUS:                  Sum of CPU cores in nodes that are in state Ready
	RAM (GB):              Sum of memory in GB of all nodes that are in state Ready

To see all available details for a cluster, use 'gsctl show nodepool <cluster-id>/<nodepool-id>'.

To list all clusters you have access to, use 'gsctl list clusters'.
`,
		PreRun: printValidation,
		Run:    printResult,
	}
)

Types

type Arguments

type Arguments struct {
	// contains filtered or unexported fields
}