From afcf859cf70f884d2d29ba8fbbe6d52f8a251f9c Mon Sep 17 00:00:00 2001 From: hiroTochigi Date: Fri, 26 Jan 2024 21:33:53 -0600 Subject: [PATCH] Add README.md with detailed usage instructions for driver.sh - Created README.md to offer comprehensive guidance on using driver.sh. - Includes instructions for the 'init' and 'delete' commands, script setup, and options for the 'init' command. - Enhances user understanding and ease of use for the script. --- src/aws/README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 src/aws/README.md diff --git a/src/aws/README.md b/src/aws/README.md new file mode 100644 index 00000000..95e819ff --- /dev/null +++ b/src/aws/README.md @@ -0,0 +1,37 @@ +# AWS EC2 Management Script + +This script is designed to simplify the management of AWS EC2 instances. It provides easy-to-use commands for initializing and deleting EC2 instances. + +## Usage + +This script supports two main commands: init and delete. + +### Command: init + +The init command verifies the AWS CLI installation, checks for the existence of an SSH key, and defines functions for importing an SSH key and adding ports in AWS EC2. + +```bash +./driver.sh init [additional options] +``` + +Options for init: + +- -n [ssh key name]: Specify a name for the SSH key on AWS. +- -a [balloon name]: Change the SSH key name, instance name, and group name, based on the provided balloon name. +- -p: Use stored port numbers instead of the default port number. + +### Command: delete + +The delete command deletes an AWS EC2 instance and its related resources, identified by a given "balloon name". It also handles cleanup tasks such as removing SSH tunnels and deleting security keys. + +```bash +./driver.sh delete [balloon name] +``` + +### Help + +To view the usage instructions, use the following command: + +```bash +./driver.sh +```