feat(terraform): add support for generic cluster template (#22)

* feat(terraform): add support for generic cluster template

Introduce a new "generic" cluster template to enhance flexibility
in cluster configurations. This addition allows for a more
customizable and adaptable setup, catering to diverse deployment
needs.

* style(setup_truefoundry_cluster.sh): adjust indentation for consistency and readability

* chore(workflows): update workflow references to ensure consistency

Updated the workflow files for linting, documentation generation, and vulnerability scanning to maintain consistency in the usage of external workflow references. No functional changes were made, only formatting adjustments to ensure proper end-of-file newlines.

* fix(get_environment.sh): quote file paths to prevent word splitting and ensure correct file handling

* trigger commit

* style(setup_truefoundry_cluster.sh): convert indentation from tabs to spaces for consistency and readability

.github/workflows/lint_clean.yaml

@@ -6,4 +6,4 @@ on:
 jobs:
   fmt_and_lint:
     name: Terraform fmt and tflint
-    uses: truefoundry/github-workflows-public/.github/workflows/[email protected]
+    uses: truefoundry/github-workflows-public/.github/workflows/[email protected]

.github/workflows/terraform-docs.yaml

@@ -7,4 +7,4 @@ jobs:
     name: Generate terraform docs
     uses: truefoundry/github-workflows-public/.github/workflows/[email protected]
     with:
-      commit_ref: ${{ github.event.pull_request.head.ref }}
+      commit_ref: ${{ github.event.pull_request.head.ref }}

.github/workflows/terraform-scan.yaml

@@ -7,4 +7,4 @@ jobs:
     name: Vulnerability scanning
     uses: truefoundry/github-workflows-public/.github/workflows/[email protected]
     secrets:
-      snyk_token: ${{ secrets.SNYK_TOKEN }}
+      snyk_token: ${{ secrets.SNYK_TOKEN }}

locals.tf

@@ -78,6 +78,7 @@ locals {
     "aws-eks"          = "${path.module}/templates/cluster/aws.json.tpl"
     "azure-aks"        = "${path.module}/templates/cluster/azure.json.tpl"
     "gcp-gke-standard" = "${path.module}/templates/cluster/gcp.json.tpl"
+    "generic"          = "${path.module}/templates/cluster/generic.json.tpl"
   }
 
   # AWS provider configuration

scripts/get_environment.sh

@@ -10,11 +10,11 @@ TRUEFOUNDRY_STDERR_FILE=\(.stderr_log_file)
 
 # Logging functions
 function log_info() {
-    echo "get_environment_name.sh - [INFO] - $1" >> $TRUEFOUNDRY_STDOUT_FILE
+    echo "get_environment_name.sh - [INFO] - $1" >> "$TRUEFOUNDRY_STDOUT_FILE"
 }
 
 function log_error() {
-    echo "get_environment_name.sh - [ERROR] - $1" >> $TRUEFOUNDRY_STDERR_FILE
+    echo "get_environment_name.sh - [ERROR] - $1" >> "$TRUEFOUNDRY_STDERR_FILE"
 }
 
 # Error handling
@@ -30,9 +30,9 @@ function handle_error() {
 [ -z "${TRUEFOUNDRY_STDERR_FILE}" ] && handle_error "TRUEFOUNDRY_STDERR_FILE is required"
 
 
-echo "" > $TRUEFOUNDRY_STDOUT_FILE
-echo "" > $TRUEFOUNDRY_STDERR_FILE
-log_info "Starting script ....\n" >> $TRUEFOUNDRY_STDOUT_FILE
+echo "" > "$TRUEFOUNDRY_STDOUT_FILE"
+echo "" > "$TRUEFOUNDRY_STDERR_FILE"
+log_info "Starting script ....\n" >> "$TRUEFOUNDRY_STDOUT_FILE"
 
 function make_request() {
     local method="$1"
@@ -144,4 +144,4 @@ function main() {
 
 output=$(main)
 echo "$output"
-log_info "Completed script ..." >> $TRUEFOUNDRY_STDOUT_FILE
+log_info "Completed script ..." >> "$TRUEFOUNDRY_STDOUT_FILE"

scripts/setup_truefoundry_cluster.sh

@@ -21,11 +21,11 @@ function handle_error() {
 
 # Logging functions
 function log_info() {
-    echo "[INFO] $1" >> "$TRUEFOUNDRY_STDOUT_FILE"
+    echo "[INFO] $1" >>"$TRUEFOUNDRY_STDOUT_FILE"
 }
 
 function log_error() {
-    echo "[ERROR] $1" >> "$TRUEFOUNDRY_STDERR_FILE"
+    echo "[ERROR] $1" >>"$TRUEFOUNDRY_STDERR_FILE"
 }
 
 # Validate required parameters
@@ -53,11 +53,11 @@ function make_request() {
     [ -n "$body" ] && curl_cmd="$curl_cmd -d '${body}'"
 
     # Execute request and capture response, redirect all output to stderr
-    eval "${curl_cmd} '${url}'" > "${response_file}" 2>>"$TRUEFOUNDRY_STDERR_FILE"
+    eval "${curl_cmd} '${url}'" >"${response_file}" 2>>"$TRUEFOUNDRY_STDERR_FILE"
     local curl_exit_code=$?
 
     # Get HTTP status code, redirect all output to stderr
-    eval "${curl_cmd} -o /dev/null -w '%{http_code}' '${url}'" > "${http_code_file}" 2>>"$TRUEFOUNDRY_STDERR_FILE"
+    eval "${curl_cmd} -o /dev/null -w '%{http_code}' '${url}'" >"${http_code_file}" 2>>"$TRUEFOUNDRY_STDERR_FILE"
     local http_code=$(<"${http_code_file}")
 
     # Cleanup
@@ -75,28 +75,27 @@ function make_request() {
         local error_msg="Request failed with status code: ${http_code}"
         log_error "$error_msg"
         log_error "Response body:"
-        cat "${response_file}" >> "$TRUEFOUNDRY_STDERR_FILE"
+        cat "${response_file}" >>"$TRUEFOUNDRY_STDERR_FILE"
         rm -f "${response_file}"
         handle_error "$error_msg"
         return 1
     fi
-    
+
     # Output response
     cat "${response_file}"
     rm -f "${response_file}"
     return 0
 }
 
-
 function is_cluster_provisioned() {
     log_info "is_cluster_provisioned: Checking if cluster exists and is provisioned..."
 
     # Make GET request to check cluster status
-    local response=$(make_request "GET" "${CONTROL_PLANE_URL}/api/svc/v1/cluster/${CLUSTER_NAME}" "" "200") || {
+    local response=$(make_request "GET" "${CONTROL_PLANE_URL}/api/svc/v1/cluster/${CLUSTER_NAME}" "" "200,400") || {
         log_info "is_cluster_provisioned: Cluster doesn't exist, creating ${CLUSTER_NAME} in control plane"
         return 0
     }
-    
+
     # Check if the request was successful
     local provisioned
     provisioned=$(echo "$response" | jq -r '.provisioned')
@@ -116,7 +115,7 @@ function create_cluster() {
     [ $? -ne 0 ] && handle_error "Failed to decode CLUSTER_CONFIG_BASE64"
 
     log_info "create_cluster: cluster manifest ${manifest}"
-    
+
     local response=$(make_request "PUT" "${CONTROL_PLANE_URL}/api/svc/v1/cluster/" "${manifest}" "200,201")
     [ $? -ne 0 ] && handle_error "Failed to create cluster"
 
@@ -125,7 +124,6 @@ function create_cluster() {
     local cluster_id=$(echo "${response}" | jq -r '.id')
     [ $? -ne 0 ] && handle_error "Failed to parse cluster response"
 
-
     log_info "create_cluster: Cluster ID $cluster_id"
     [ -z "${cluster_id}" ] && handle_error "No cluster ID found in response"
 
@@ -141,11 +139,11 @@ function get_cluster_token() {
         "${CONTROL_PLANE_URL}/api/svc/v1/cluster/${cluster_id}/token" \
         "" "200")
     [ $? -ne 0 ] && handle_error "Failed to get cluster token"
-    
+
     local token=$(echo "${response}" | jq -r '.clusterToken')
     [ $? -ne 0 ] && handle_error "Failed to parse cluster token response"
     [ -z "${token}" ] && handle_error "No cluster token found in response" && return 1
-    
+
     echo "${token}"
 }
 
@@ -154,7 +152,6 @@ function setup_provider_account() {
 
     # Ensure required environment variables are set
     [ -z "$PROVIDER_CONFIG_BASE64" ] && handle_error "setup_provider_account: PROVIDER_CONFIG_BASE64 is required"
-
 
     log_info "setup_provider_account: Creating provider account..."
 
@@ -191,13 +188,13 @@ function main() {
     local cluster_token
 
     # Check if cluster exists and is provisioned
-        local cluster_status=$(is_cluster_provisioned)
-        log_info "main: Cluster status: ${cluster_status}"
-        
+    local cluster_status=$(is_cluster_provisioned)
+    log_info "main: Cluster status: ${cluster_status}"
+
     if [ "${cluster_status}" = "true" ]; then
-            log_info "main: Cluster already exists and is provisioned. Skipping creation."
-            # Get existing cluster ID from the response
-            cluster_id=$(make_request "GET" "${CONTROL_PLANE_URL}/api/svc/v1/cluster/${CLUSTER_NAME}" "" "200" | jq -r '.id')
+        log_info "main: Cluster already exists and is provisioned. Skipping creation."
+        # Get existing cluster ID from the response
+        cluster_id=$(make_request "GET" "${CONTROL_PLANE_URL}/api/svc/v1/cluster/${CLUSTER_NAME}" "" "200" | jq -r '.id')
     else
         if [ "${CLUSTER_TYPE}" != "generic" ]; then
             # Setup provider account and create cluster if not provisioned or doesn't exist
@@ -208,7 +205,6 @@ function main() {
         fi
     fi
 
-
     cluster_token=$(get_cluster_token "${cluster_id}") || handle_error "Failed to get cluster token"
 
     log_info "main: cluster_id=$cluster_id"