Made columns customizable when selecting ec2 instances

Author: null93

README.md

@@ -141,9 +141,32 @@ sso_start_url = https://d-0000000000.awsapps.com/start
 
 The Knox config file is located at `~/.aws/knox/config.yaml`. Below are the configuration options available:
 
-| Option                | Default | Description                                                                                            |
-|-----------------------|---------|--------------------------------------------------------------------------------------------------------|
-| `default_connect_uid` | `0`     | Default user ID for SSM sessions initiated with the `knox connect` command.                            |
-| `max_items_to_show`   | `10`    | Maximum number of items to display when listing profiles or options.                                   |
-| `select_cached_first` | `false` | When selecting credentials, specifies whether to default to showing the cached role credentials first. |
-| `account_aliases`     | `{}`    | Account aliases for AWS accounts. Key is the account ID, and value is the account alias.               |
+### `default_connect_uid`
+
+Default value is `0` (root).
+
+Default user ID for SSM sessions initiated with the `knox connect` command.
+
+### `max_items_to_show`
+
+Default value is `10`.
+
+Maximum number of items to display when listing profiles or options.
+
+### `select_cached_first`
+
+Default value is `false`.
+
+When selecting credentials, specifies whether to default to showing the cached role credentials first.
+
+### `account_aliases`
+
+Default value is `{}`.
+
+Account aliases for AWS accounts. Key is the account ID, and value is the account alias.
+
+### `instance_col_tags`
+
+Default value is `["Instance Type", "Private IP", "Public IP", "Name"]`.
+
+Specify "Instance Type", "Private IP", or "Public IP" to display when selecting an instance. All other values are extracted from tags.

internal/connect.go

@@ -83,7 +83,7 @@ var connectCmd = &cobra.Command{
 			}
 			if instanceId == "" {
 				if currentSelector == "instance" {
-					if instanceId, action, err = tui.SelectInstance(role, region, searchTerm); err != nil {
+					if instanceId, action, err = tui.SelectInstance(role, region, searchTerm, instanceColTags); err != nil {
 						ExitWithError(19, "failed to pick an instance", err)
 					} else if action == "back" {
 						goBack()

internal/root.go

@@ -25,6 +25,7 @@ var (
 	instanceId        string
 	region            string
 	accountAliases    map[string]string
+	instanceColTags   []string
 )
 
 const (
@@ -176,12 +177,14 @@ func setupConfigFile() {
 	viper.SetDefault("select_cached_first", false)
 	viper.SetDefault("max_items_to_show", 10)
 	viper.SetDefault("account_aliases", map[string]string{})
+	viper.SetDefault("instance_col_tags", []string{"Instance Type", "Private IP", "Public IP", "Name"})
 	viper.SafeWriteConfig()
 	viper.ReadInConfig()
 	tui.MaxItemsToShow = viper.GetInt("max_items_to_show")
 	selectCachedFirst = viper.GetBool("select_cached_first")
 	connectUid = viper.GetUint32("default_connect_uid")
 	accountAliases = viper.GetStringMapString("account_aliases")
+	instanceColTags = viper.GetStringSlice("instance_col_tags")
 }
 
 func init() {

internal/sync.go

@@ -232,7 +232,7 @@ var syncCmd = &cobra.Command{
 			}
 			if instanceId == "" {
 				if currentSelector == "instance" {
-					if instanceId, action, err = tui.SelectInstance(role, region, searchTerm); err != nil {
+					if instanceId, action, err = tui.SelectInstance(role, region, searchTerm, instanceColTags); err != nil {
 						ExitWithError(19, "failed to pick an instance", err)
 					} else if action == "back" {
 						goBack()

sdk/credentials/session.go

@@ -29,10 +29,10 @@ type Instances []Instance
 
 type Instance struct {
 	Id               string
-	Name             string
 	InstanceType     string
 	PrivateIpAddress string
 	PublicIpAddress  string
+	Tags             map[string]string
 }
 
 func (r *Role) StartSession(instanceId string, defaultUid uint32) (*ssm.StartSessionOutput, error) {
@@ -141,7 +141,6 @@ func (r *Role) GetManagedInstances(region string) (Instances, error) {
 		}
 		for _, info := range page.Reservations {
 			for _, instance := range info.Instances {
-				name := "-"
 				privateId := "-"
 				publicId := "-"
 				if instance.PrivateIpAddress != nil {
@@ -150,17 +149,18 @@ func (r *Role) GetManagedInstances(region string) (Instances, error) {
 				if instance.PublicIpAddress != nil {
 					publicId = aws.ToString(instance.PublicIpAddress)
 				}
+				tags := map[string]string{}
 				for _, tag := range instance.Tags {
-					if aws.ToString(tag.Key) == "Name" {
-						name = aws.ToString(tag.Value)
-					}
+					key := aws.ToString(tag.Key)
+					value := aws.ToString(tag.Value)
+					tags[key] = value
 				}
 				instance := Instance{
 					Id:               aws.ToString(instance.InstanceId),
-					Name:             name,
 					InstanceType:     string(instance.InstanceType),
 					PrivateIpAddress: privateId,
 					PublicIpAddress:  publicId,
+					Tags:             tags,
 				}
 				instances = append(instances, instance)
 			}

sdk/tui/tui.go

@@ -149,20 +149,47 @@ func SelectRole(roles credentials.Roles) (string, string, error) {
 	return selection.Value.(string), "", nil
 }
 
-func SelectInstance(role *credentials.Role, region, initialFilter string) (string, string, error) {
+func cutOff(s string, n int) string {
+	if len(s) > n {
+		return s[:n-1] + "…"
+	}
+	return s
+}
+
+func SelectInstance(role *credentials.Role, region, initialFilter string, instanceColTags []string) (string, string, error) {
 	instances, err := role.GetManagedInstances(region)
 	if err != nil {
 		return "", "", err
 	}
+	cols := []string{"Instance ID"}
+	for _, tag := range instanceColTags {
+		cols = append(cols, tag)
+	}
 	p := picker.NewPicker()
 	p.WithMaxHeight(MaxItemsToShow)
 	p.WithEmptyMessage("No Instances Found")
 	p.WithTitle(fmt.Sprintf("Pick EC2 Instance (%s)", region))
-	p.WithHeaders("Instance ID", "Instance Type", "Private IP", "Public IP", "Name")
+	p.WithHeaders(cols...)
 	p.AddAction(keys.Esc, "esc", "go back")
 	p.AddAction(keys.F1, "f1", "pick region")
 	for _, instance := range instances {
-		p.AddOption(instance.Id, instance.Id, instance.InstanceType, instance.PrivateIpAddress, instance.PublicIpAddress, instance.Name)
+		values := []string{instance.Id}
+		for _, tag := range instanceColTags {
+			value := "-"
+			switch tag {
+			case "Instance Type":
+				value = instance.InstanceType
+			case "Private IP":
+				value = instance.PrivateIpAddress
+			case "Public IP":
+				value = instance.PublicIpAddress
+			default:
+				value = instance.Tags[tag]
+			}
+			value = cutOff(value, 36)
+			values = append(values, value)
+		}
+		p.AddOption(instance.Id, values...)
 	}
 	selection, firedKeyCode := p.Pick(initialFilter)
 	if firedKeyCode != nil && *firedKeyCode == keys.Esc {