Skip to content

Commit 5c6ea66

Browse files
Merge pull request #11 from prashantkalkar/doc_update
Updated documentation as per new variables for the modules.
2 parents 896411a + 0f78960 commit 5c6ea66

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -173,13 +173,13 @@ https://aws.amazon.com/premiumsupport/knowledge-center/ec2-ubuntu-secondary-netw
173173
| <a name="input_asg_inservice_timeout_in_mins"></a> [asg\_inservice\_timeout\_in\_mins](#input\_asg\_inservice\_timeout\_in\_mins) | Timeout in mins which will be used by the rolling update script to wait for instances to be InService for an ASG | `number` | `10` | no |
174174
| <a name="input_asg_lifecycle_hook_heartbeat_timeout"></a> [asg\_lifecycle\_hook\_heartbeat\_timeout](#input\_asg\_lifecycle\_hook\_heartbeat\_timeout) | Timeout for ASG initial lifecycle hook. This is used only during ASG creation, subsequent value changes are not handled by terraform (has to be updated manually) | `number` | `3600` | no |
175175
| <a name="input_command_timeout_seconds"></a> [command\_timeout\_seconds](#input\_command\_timeout\_seconds) | The timeout that will be used by the userdata script to retry commands on failure. Keep it higher to allow manual recovery | `number` | `1800` | no |
176-
| <a name="input_data_volume"></a> [data\_volume](#input\_data\_volume) | device\_name = "Device name for additional Data volume, select name as per https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html"<br> type = "EBS volume type e.g. gp2, gp3 etc"<br> iops = "Only valid for type gp3"<br> throughput\_mib\_per\_sec = "only valid for type gp3"<br> mount\_path = "path where to mount the data volume"<br> file\_system\_type = "File system to use to format the volume. eg. ext4 or xfs. This is used only initial time. Later changes will be ignored"<br> mount\_params = "Parameters to be used while mounting the volume eg. noatime etc. Optional, empty if not provided"<br> mount\_path\_owner\_user = "OS user that should own volume mount path will be used for chown"<br> mount\_path\_owner\_group = "OS group that should own the volume mount path, will be used for chown" | <pre>object({<br> device_name = optional(string, "/dev/sdf")<br> size_in_gibs = number<br> type = string<br> iops = optional(number)<br> throughput_mib_per_sec = optional(number)<br> mount_path = string<br> file_system_type = string<br> mount_params = optional(list(string), [])<br> mount_path_owner_user = string<br> mount_path_owner_group = string<br> })</pre> | n/a | yes |
176+
| <a name="input_data_volume"></a> [data\_volume](#input\_data\_volume) | device\_name = "Device name for additional Data volume, select name as per https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html"<br> type = "EBS volume type e.g. gp2, gp3 etc"<br> iops = "Only valid for type gp3"<br> throughput\_mib\_per\_sec = "only valid for type gp3"<br> mount\_path = "path where to mount the data volume"<br> file\_system\_type = "File system to use to format the volume. eg. ext4 or xfs. This is used only initial time. Later changes will be ignored"<br> mount\_params = "Parameters to be used while mounting the volume eg. noatime etc. Optional, empty if not provided"<br> mount\_path\_owner\_user = "OS user that should own volume mount path will be used for chown"<br> mount\_path\_owner\_group = "OS group that should own the volume mount path, will be used for chown" | <pre>object({<br> device_name = optional(string, "/dev/sdf")<br> size_in_gibs = number<br> type = string<br> iops = optional(number)<br> throughput_mib_per_sec = optional(number)<br> mount_path = string<br> file_system_type = string<br> mount_params = optional(list(string), [])<br> mount_path_owner_user = string<br> mount_path_owner_group = string<br> tags = optional(map(string), {})<br> })</pre> | n/a | yes |
177177
| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | n/a | `string` | n/a | yes |
178178
| <a name="input_jq_download_url"></a> [jq\_download\_url](#input\_jq\_download\_url) | n/a | `string` | `"https://github.com/stedolan/jq/releases/download/jq-1.6/jq-linux64"` | no |
179179
| <a name="input_node_config_script"></a> [node\_config\_script](#input\_node\_config\_script) | Base64 encoded node configuration shell script.<br> Must include configure\_cluster\_node and wait\_for\_healthy\_cluster function. Check documentation for more details about the contract | `string` | n/a | yes |
180180
| <a name="input_node_image"></a> [node\_image](#input\_node\_image) | n/a | `string` | n/a | yes |
181181
| <a name="input_node_key_name"></a> [node\_key\_name](#input\_node\_key\_name) | n/a | `string` | n/a | yes |
182-
| <a name="input_nodes"></a> [nodes](#input\_nodes) | node\_ip = IP address of the cluster node. This should be available within the subnet.<br> node\_subnet\_id = Id of the subnet where node should be created.<br> node\_files\_toupload = list of file to be uploaded per node. These can be cluster confi files etc.<br> node\_files\_toupload.contents = Base64 encoded contents of the file to be uploaded on the node.<br> node\_files\_toupload.destination = File destination on the node. This will be the file path and name on the node. The file ownership should be changed by node\_config\_script. | <pre>list(object({<br> node_ip = string<br> node_subnet_id = string<br> node_files_toupload = optional(list(object({<br> contents = string<br> destination = string<br> })), [])<br> }))</pre> | n/a | yes |
182+
| <a name="input_nodes"></a> [nodes](#input\_nodes) | node\_ip = IP address of the cluster node. This should be available within the subnet.<br> node\_image = image for node of the cluster node.<br> node\_subnet\_id = Id of the subnet where node should be created.<br> node\_files\_toupload = list of file to be uploaded per node. These can be cluster confi files etc.<br> node\_files\_toupload.contents = Base64 encoded contents of the file to be uploaded on the node.<br> node\_files\_toupload.destination = File destination on the node. This will be the file path and name on the node. The file ownership should be changed by node\_config\_script. | <pre>list(object({<br> node_ip = string<br> node_image = optional(string)<br> node_subnet_id = string<br> node_files_toupload = optional(list(object({<br> contents = string<br> destination = string<br> })), [])<br> }))</pre> | n/a | yes |
183183
| <a name="input_root_volume"></a> [root\_volume](#input\_root\_volume) | n/a | <pre>object({<br> device_name = string<br> size_in_gibs = number<br> type = string<br> })</pre> | <pre>{<br> "device_name": "/dev/xvda",<br> "size_in_gibs": 16,<br> "type": "gp3"<br>}</pre> | no |
184184
| <a name="input_security_groups"></a> [security\_groups](#input\_security\_groups) | n/a | `list(string)` | n/a | yes |
185185

modules/node-module/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ No modules.
6464
| <a name="input_app_name"></a> [app\_name](#input\_app\_name) | n/a | `string` | n/a | yes |
6565
| <a name="input_asg_lifecycle_hook_heartbeat_timeout"></a> [asg\_lifecycle\_hook\_heartbeat\_timeout](#input\_asg\_lifecycle\_hook\_heartbeat\_timeout) | n/a | `number` | n/a | yes |
6666
| <a name="input_command_timeout_seconds"></a> [command\_timeout\_seconds](#input\_command\_timeout\_seconds) | n/a | `number` | n/a | yes |
67-
| <a name="input_data_volume"></a> [data\_volume](#input\_data\_volume) | n/a | <pre>object({<br> device_name = string<br> size_in_gibs = number<br> type = string<br> iops = optional(number)<br> throughput_mib_per_sec = optional(number)<br> mount_path = string<br> file_system_type = string<br> mount_params = list(string)<br> mount_path_owner_user = string<br> mount_path_owner_group = string<br> })</pre> | n/a | yes |
67+
| <a name="input_data_volume"></a> [data\_volume](#input\_data\_volume) | n/a | <pre>object({<br> device_name = string<br> size_in_gibs = number<br> type = string<br> iops = optional(number)<br> throughput_mib_per_sec = optional(number)<br> mount_path = string<br> file_system_type = string<br> mount_params = list(string)<br> mount_path_owner_user = string<br> mount_path_owner_group = string<br> tags = optional(map(string), {})<br> })</pre> | n/a | yes |
6868
| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | n/a | `string` | n/a | yes |
6969
| <a name="input_jq_download_url"></a> [jq\_download\_url](#input\_jq\_download\_url) | n/a | `string` | n/a | yes |
7070
| <a name="input_node_config_script"></a> [node\_config\_script](#input\_node\_config\_script) | n/a | `string` | n/a | yes |

0 commit comments

Comments
 (0)