hotfix: block override (#6)

* fix: don't overwrite an existing block's content

* fix: don't overwrite an existing block's content

* README nitpick

* README nitpick

* terraform-docs

Author: lbkolev

README.md

@@ -2,7 +2,6 @@
 ### <p align="center">Spin up ETH clients. On AWS. In a minute.</p>
 
 - The deployment takes no more than a minute
-- The default OS is `debian12`
 - All clients are managed through systemd
 
 - The module takes care of the:
@@ -12,7 +11,7 @@
 - Full examples can be found in the [examples](./examples/) directory.
 > :warning: Be mindful with the security group's configuration. All the examples are simplified to allow all external traffic, which in most cases isn't recommended.
 
-## Example with Reth & Lighthouse running sepolia
+## Example with Reth & Lighthouse 
 ```hcl
 module "nodes" {
   source = "../../"
@@ -92,13 +91,16 @@ MIT Licensed. See [LICENSE](./LICENSE) for full details.
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 
-No requirements.
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.15.0 |
 
 ## Modules
 
@@ -109,6 +111,7 @@ No modules.
 | Name | Type |
 |------|------|
 | [aws_ebs_volume.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ebs_volume) | resource |
+| [aws_ec2_instance_state.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ec2_instance_state) | resource |
 | [aws_instance.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance) | resource |
 | [aws_security_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
 | [aws_volume_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/volume_attachment) | resource |
@@ -120,9 +123,9 @@ No modules.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_ami"></a> [ami](#input\_ami) | The base AMI to use for the EC2 | <pre>object({<br>    name = string<br>  })</pre> | <pre>{<br>  "name": "debian-12-amd64-20230711-1438"<br>}</pre> | no |
-| <a name="input_clients"></a> [clients](#input\_clients) | The ETH clients to deploy on the EC2 | <pre>list(<br>    object({<br>      name        = string<br>      package_url = string<br>      cmd         = string<br><br>      ebs = optional(object({<br>        device_name = string<br>        mountpoint  = string<br><br>        // Required if we're attaching an external EBS, rather than creation one here<br>        attach_external_ebs = optional(bool)<br>        external_volume_id  = optional(string)<br><br>        // Required if we're creating an EBS, rather than attaching an external one<br>        ebs_name = optional(string)<br>        type     = optional(string)<br>        size     = optional(number)<br>      }))<br>  }))</pre> | n/a | yes |
-| <a name="input_ec2"></a> [ec2](#input\_ec2) | The EC2 configuration | <pre>object({<br>    type                        = optional(string)<br>    associate_public_ip_address = bool<br>    key_name                    = string<br>    security_group_ids          = optional(list(string)) // optional external SGs; ones created outside of this module.<br>    disable_api_stop            = optional(bool)<br>    disable_api_termination     = optional(bool)<br>    ebs_optimized               = optional(bool)<br>    get_password_data           = optional(bool)<br>    hibernation                 = optional(bool)<br>    key_name                    = optional(string)<br>  })</pre> | n/a | yes |
-| <a name="input_name"></a> [name](#input\_name) | The generic name to apply across the different resources | `string` | n/a | yes |
+| <a name="input_clients"></a> [clients](#input\_clients) | The nodes to deploy on the EC2 | <pre>list(<br>    object({<br>      name        = string # name of the ethereum client<br>      package_url = string # link to the url of the binary to download<br>      cmd         = string # the startup command of the client<br><br>      ebs = optional(object({<br>        device_name = string<br>        mountpoint  = string<br><br>        # Required if we're attaching an external EBS, rather than creation one here<br>        attach_external_ebs = optional(bool)<br>        external_volume_id  = optional(string)<br><br>        # Required if we're creating an EBS, rather than attaching an external one<br>        ebs_name = optional(string)<br>        type     = optional(string)<br>        size     = optional(number)<br>      }))<br>  }))</pre> | n/a | yes |
+| <a name="input_ec2"></a> [ec2](#input\_ec2) | The EC2 configuration | <pre>object({<br>    type                        = optional(string, "t2.micro")<br>    state                       = optional(string, "running")<br>    associate_public_ip_address = bool<br>    security_group_ids          = optional(list(string)) # external SGs;<br>    disable_api_stop            = optional(bool)<br>    disable_api_termination     = optional(bool)<br>    ebs_optimized               = optional(bool)<br>    get_password_data           = optional(bool)<br>    hibernation                 = optional(bool)<br>    key_name                    = optional(string)<br>  })</pre> | <pre>{<br>  "associate_public_ip_address": true,<br>  "state": "running",<br>  "type": "t2.micro"<br>}</pre> | no |
+| <a name="input_name"></a> [name](#input\_name) | The generic name to apply across the different resources created in AWS | `string` | n/a | yes |
 | <a name="input_security_group"></a> [security\_group](#input\_security\_group) | The security group rules to apply to the EC2 | <pre>list(object({<br>    type        = string<br>    description = optional(string)<br>    from        = number<br>    to          = number<br>    protocol    = string<br>    cidr_blocks = list(string)<br>  }))</pre> | `[]` | no |
 | <a name="input_subnet_id"></a> [subnet\_id](#input\_subnet\_id) | The subnet to deploy the EC2 in. Defaults to the first subnet returned by the data resource | `string` | n/a | yes |
 

examples/besu-nimbus-mainnet/README.md

@@ -35,6 +35,6 @@ No inputs.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_key_pair"></a> [key\_pair](#output\_key\_pair) | n/a |
-| <a name="output_nodes"></a> [nodes](#output\_nodes) | n/a |
+| <a name="output_key_pair"></a> [key\_pair](#output\_key\_pair) | Details around the SSH key pair for the manager node |
+| <a name="output_node"></a> [node](#output\_node) | Details around the EC2 |
 <!-- END_TF_DOCS -->

examples/geth-teku-mainnet/README.md

@@ -34,6 +34,6 @@ No inputs.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_key_pair"></a> [key\_pair](#output\_key\_pair) | n/a |
-| <a name="output_nodes"></a> [nodes](#output\_nodes) | n/a |
+| <a name="output_key_pair"></a> [key\_pair](#output\_key\_pair) | Details around the SSH key pair for the manager node |
+| <a name="output_node"></a> [node](#output\_node) | Details around the EC2 |
 <!-- END_TF_DOCS -->

examples/reth-lighthouse-sepolia/README.md

@@ -34,6 +34,6 @@ No inputs.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_key_pair"></a> [key\_pair](#output\_key\_pair) | n/a |
-| <a name="output_nodes"></a> [nodes](#output\_nodes) | n/a |
+| <a name="output_key_pair"></a> [key\_pair](#output\_key\_pair) | Details around the SSH key pair for the manager node |
+| <a name="output_node"></a> [node](#output\_node) | Details around the EC2 |
 <!-- END_TF_DOCS -->

templates/init.sh.tftpl

@@ -14,12 +14,19 @@ function setup() {
     local package=$(echo $url | awk -F '/' '{print $NF}')
 
     if [[ -n "$device_name" ]] && [[ -n "$mountpoint" ]]; then
-        mkdir -p $mountpoint && \
-        mkfs -t ext4 /dev/$device_name && \
+        mkdir -p $mountpoint
+
+        # determine if we're remounting a block with an already existing FS or creating a new one
+        # otherwise we'll overwrite the existing content of the block by recreating the FS
+        if [[ $(blkid /dev/$device_name) ]]; then
+            echo "Found existing filesystem on /dev/$device_name"
+        else
+            echo "Creating new filesystem (ext4) on /dev/$device_name"
+            mkfs -t ext4 /dev/$device_name
+        fi
+
         echo "/dev/$device_name $mountpoint ext4 defaults 0 0" >> /etc/fstab && \
-        mount -a && \
-        systemctl daemon-reload && \
-        sleep 2
+        mount -a 
     fi
 
     case "$executable_name" in