allow configuring timeout value for linodeclient

Author: rahulait

.github/workflows/e2e-test.yaml

@@ -135,6 +135,7 @@ jobs:
           LINODE_CONTROL_PLANE_MACHINE_TYPE: g6-standard-2
           LINODE_MACHINE_TYPE: g6-standard-2
           CLUSTERCTL_CONFIG: /home/runner/work/cluster-api-provider-linode/cluster-api-provider-linode/e2e/gha-clusterctl-config.yaml
+          LINODE_CLIENT_TIMEOUT: 30
         run: make e2etest
 
       - name: cleanup stale clusters

Tiltfile

@@ -196,6 +196,13 @@ for resource in manager_yaml:
         resource["spec"]["template"]["spec"].pop("securityContext")
         for container in resource["spec"]["template"]["spec"]["containers"]:
             container.pop("securityContext")
+            timeout_value = os.getenv("LINODE_CLIENT_TIMEOUT")
+            if timeout_value:
+                env = container.setdefault("env", [])
+                env.append({
+                    "name": "LINODE_CLIENT_TIMEOUT",
+                    "value": timeout_value
+                })
 
 k8s_yaml(encode_yaml_stream(manager_yaml))
 

cmd/main.go

@@ -178,8 +178,23 @@ func validateEnvironment() (linodeConfig, dnsConfig scope.ClientConfig) {
 		linodeDNSToken = linodeToken
 	}
 
-	return scope.ClientConfig{Token: linodeToken},
-		scope.ClientConfig{Token: linodeDNSToken, BaseUrl: linodeDNSURL, RootCertificatePath: linodeDNSCA}
+	linodeClientTimeout := 0
+	if raw, ok := os.LookupEnv("LINODE_CLIENT_TIMEOUT"); ok {
+		if timeout, err := strconv.Atoi(raw); timeout > 0 && err == nil {
+			linodeClientTimeout = timeout
+			setupLog.Info("LINODE_CLIENT_TIMEOUT set", "timeout", linodeClientTimeout)
+		} else {
+			setupLog.Error(fmt.Errorf("invalid LINODE_CLIENT_TIMEOUT value: %s", raw), "using default timeout")
+		}
+	}
+
+	linodeConfig = scope.ClientConfig{Token: linodeToken}
+	dnsConfig = scope.ClientConfig{Token: linodeDNSToken, BaseUrl: linodeDNSURL, RootCertificatePath: linodeDNSCA}
+	if linodeClientTimeout > 0 {
+		linodeConfig.Timeout = time.Duration(linodeClientTimeout) * time.Second
+		dnsConfig.Timeout = time.Duration(linodeClientTimeout) * time.Second
+	}
+	return linodeConfig, dnsConfig
 }
 
 // setupManager initializes and returns a new manager instance with the provided configurations.

docs/src/topics/troubleshooting.md

@@ -73,3 +73,20 @@ You can also see which images have cloud-init support via the [linode-cli](https
 
 Please refer to the [Troubleshoot Metadata and Cloud-Init section of the Linode Metadata Service Guide](https://www.linode.com/docs/products/compute/compute-instances/guides/metadata/?tabs=linode-api%2Cmacos#troubleshoot-metadata-and-cloud-init).
 
+## Increasing Linode API timeout values
+If the Linode API is slow to provision resources and you need to increase the timeout for API calls, you can set the LINODE_CLIENT_TIMEOUT environment variable to a higher value (in seconds). CAPL will automatically use this value when interacting with the Linode API.
+
+```bash
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: capl-controller-manager
+spec:
+  template:
+    spec:
+      containers:
+        - name: manager
+          env:
+            - name: LINODE_CLIENT_TIMEOUT
+              value: "60"  # Timeout in seconds
+```