Merged Andrew Kesterson requested to merge 2514_k3d_dev_long_names into master 1 month ago

General MR

Summary

This MR adds long argument names to the k3d-dev.sh script arguments. With the increasing number of arguments, the usage of single letter arguments has made it difficult to remember which switches perform which actions.

Relevant logs/screenshots

New usage message

$ /opt/homebrew/bin/bash ./docs/assets/scripts/developer/k3d-dev.sh --help
Usage:                                                                    
k3d-dev.sh [options]                                                      
                                                                          
 -c|--cloud-provider CLOUD        Use the given CLOUD for cloud     
                                  infra provisioning [aws]
                                                                          
========= The following options ONLY APPLY with [-c aws] ==========
                                                                                                                                                    
 -b|--big-instance                use BIG M5 instance. Default is 
                                  m5a.4xlarge                  
 -a|--attach-secondary-public-ip  attach secondary Public IP
                                  (overrides -p and -m flags)   
 -d|--destroy-cloud-instance      destroy related cloud resources     
 -R|--recreate-cloud-instance     recreate the cloud instance       
                                  (shortcut for -d and running 
                                  again with same flags)            
 -r|--report-cloud-instances      Report on all cloud instances
                                  owned by your user
 -u|--update-cloud-instance       Update security rules for 
                                  cloud instances               
                                     
========= These options apply regardless of cloud provider ================

 -K|--recreate-k3d                recreate the k3d cluster on host
 -m|--use-metallb                 create k3d cluster with metalLB
                                  load balancer (default)
 -M|--disable-metallb             Don't use a metalLB load balancer
 -p|--use-private-ip              use private IP for security group
                                  and k3d cluster
 -t|--project-tag                 Set the project tag on the cloud instance
                                  (for managing multiple instances)
 -w|--use-weave-cni               install the weave CNI instead of the
                                  default flannel CNI
 -i|--init-script SCRIPTFILE      initialization script to pass to
                                  instance before configuring it
 -U|--ssh-username USERNAME       username to use when connecting
                                  to existing system in -P (default
                                  value depends on cloud provider,
                                  no default value when using -H)
 -T|--no-terminate                Don't terminate the instance after
                                  8 hours
 -q|--quiet                       suppress the final completion message

========= These options override -c and use your own infrastructure =======

 -H|--existing-public-ip IPADDR   Public IP address of existing
                                  system to configure
 -P|--existing-private-ip IPADDR  Private IP address of existing
                                  system to configure (if not provided
                                  and -H is set, the value of -H is 
                                  assumed)
 -k|--ssh-keyfile KEYFILE         SSH key to use when connecting to 
                                  cluster instance

 -h|--help                        output this help