Skip to content

Commit 30c513c

Browse files
committed
chore: update variable description.
1 parent eea2a26 commit 30c513c

File tree

4 files changed

+10
-6
lines changed

4 files changed

+10
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This modules creates:
3939
| tamr\_zip\_uri | gcs location to download tamr zip from | `string` | n/a | yes |
4040
| labels | labels to attach to created resources | `map(string)` | `{}` | no |
4141
| metadata | custom metadata to attach to created VM | `map(string)` | `{}` | no |
42-
| pre\_start\_script\_content | custom script to run prior to startup\_script | `string` | `""` | no |
42+
| pre\_install\_bash | Bash to be run before Tamr is installed.<br> Likely to be used to meet Tamr's prerequisites, if not already met by the image. (https://docs.tamr.com/new/docs/requirements )<br> This will only be run once before Tamr is installed, unless Tamr fails to install. This bash will also be run on subsequent attempts to install Tamr, so it is recommended that this bash is idempotent. | `string` | `""` | no |
4343
| tamr\_external\_ip | Create and attach an external ip to tamr VM | `bool` | `false` | no |
4444
| tamr\_instance\_deletion\_protection | Enabled deletion protection for the tamr VM | `bool` | `true` | no |
4545
| tamr\_instance\_disk\_size | size of the boot disk | `number` | `100` | no |

main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ locals {
22
external_ip = var.tamr_external_ip == true ? 1 : 0
33

44
startup_script = templatefile("${path.module}/templates/startup_script.sh.tmpl", {
5-
pre_start_script = var.pre_start_script_content
5+
pre_install_bash = var.pre_install_bash
66
tamr_zip_uri = var.tamr_zip_uri
77
tamr_config = var.tamr_config_file
88
tamr_home_directory = var.tamr_instance_install_directory

templates/startup_script.sh.tmpl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ EOF
1717
# check if tamr has been installed on the VM, if not download and install it
1818
if [[ ! -f ${tamr_home_directory}/tamr/start-unify.sh ]]; then
1919
# run any custom commands to prepare VM
20-
%{ if pre_start_script }
21-
${pre_start_script}
20+
%{ if pre_install_bash }
21+
${pre_install_bash}
2222
%{ endif }
2323
# download tamr install
2424
sudo -S -u tamr -i /bin/bash -c 'gsutil cp ${tamr_zip_uri} ${tamr_home_directory}/unify.zip'

variables.tf

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,14 @@ variable "tamr_config_file" {
102102
description = "Override generated tamr configuration. The tamr configuration is specified using a yaml file, in the format that is documented (https://docs.tamr.com/previous/docs/configuration-configuring-unify#section-setting-configuration-variables) for configuring “many variables” at once."
103103
}
104104

105-
variable "pre_start_script_content" {
105+
variable "pre_install_bash" {
106106
default = ""
107107
type = string
108-
description = "custom script to run prior to startup_script"
108+
description = <<EOF
109+
Bash to be run before Tamr is installed.
110+
Likely to be used to meet Tamr's prerequisites, if not already met by the image. (https://docs.tamr.com/new/docs/requirements )
111+
This will only be run once before Tamr is installed, unless Tamr fails to install. This bash will also be run on subsequent attempts to install Tamr, so it is recommended that this bash is idempotent.
112+
EOF
109113
}
110114

111115
#

0 commit comments

Comments
 (0)