Add troubleshooting docs on ICL_TERRAFORM_DISABLE_LOCKING (#17)

aregm · Jun 5, 2024 · f73e806 · f73e806
1 parent 3924ba5
commit f73e806
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -0,0 +1,9 @@
+# Troubleshooting
+
+## Terraform locking
+In case you have your deployment script interrupted, you may have the "Error: Error locking state: Error acquiring the state lock" message.
+To disable Terraform locking, export the following variable. This has to be done once. After rerunning the deploy script, the lock will be released.
+
+```shell
+export ICL_TERRAFORM_DISABLE_LOCKING=1
+```
diff --git a/scripts/deploy/aws.sh b/scripts/deploy/aws.sh
@@ -71,7 +71,7 @@ function eks_terraform_args()
     -var gpu_type="${GPU_TYPE}"
     -var instance_type="${ICL_AWS_INSTANCE_TYPE}"
   )
-  if [[ -v X1_TERRAFORM_DISABLE_LOCKING ]]; then
+  if [[ -v X1_TERRAFORM_DISABLE_LOCKING || -v ICL_TERRAFORM_DISABLE_LOCKING ]]; then
     terraform_extra_args+=( -lock=false )
   fi
   echo "${terraform_extra_args[*]}"

diff --git a/scripts/deploy/gke.sh b/scripts/deploy/gke.sh
@@ -93,7 +93,7 @@ function x1_terraform_args() {
     -var use_node_ip_for_user_ports=true
     -var use_external_node_ip_for_user_ports=true
   )
-  if [[ -v X1_TERRAFORM_DISABLE_LOCKING ]]; then
+  if [[ -v X1_TERRAFORM_DISABLE_LOCKING || -v ICL_TERRAFORM_DISABLE_LOCKING ]]; then
     terraform_extra_args+=( -lock=false )
   fi
   # TODO: add lock release here