Skip to content

Commit

Permalink
Add README.md with detailed usage instructions for driver.sh
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
hiroTochigi committed Jan 27, 2024
1 parent 72427b0 commit afcf859
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions src/aws/README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit afcf859

Please sign in to comment.