Add option to skip package deployment (#31)

Author: shibayan

README.md

@@ -156,6 +156,24 @@ Runnable examples are available under [`examples`](examples):
 
 ### Operations
 
+- Azure Functions Flex Consumption currently returns a corrupted OneDeploy ARM
+  response, causing `azapi_resource.deployment` to fail even when the package is
+  deployed successfully. Set `skip_package_deployment = true` to omit OneDeploy
+  from Terraform and deploy the package out-of-band. `export_api_key` must remain
+  `false` in this mode because Terraform cannot order the host key lookup after
+  an external deployment.
+- The following command shows how to deploy the package after Terraform creates
+  the Function App. Replace the placeholders with the module output and desired
+  Acmebot version. The Azure CLI may still report the response parsing error;
+  verify the resulting deployment separately until the Azure platform issue is
+  resolved.
+
+  ```bash
+  az rest --method PUT \
+    --url "https://management.azure.com<function-app-resource-id>/extensions/onedeploy?api-version=2025-03-01" \
+    --body '{"properties":{"type":"zip","packageUri":"https://github.com/polymind-inc/acmebot/releases/download/v<version>/acmebot.zip","remoteBuild":false}}'
+  ```
+
 - Set `log_analytics_workspace.resource_id` and/or
   `application_insights.resource_id` to reuse existing monitoring resources.
 - Child resources inherit `var.tags` by default and support child-specific tag
@@ -715,6 +733,14 @@ object({
 
 Default: `{}`
 
+### <a name="input_skip_package_deployment"></a> [skip\_package\_deployment](#input\_skip\_package\_deployment)
+
+Description: Whether to skip deploying the Acmebot package through OneDeploy. When true, the package must be deployed out-of-band and export\_api\_key must be false.
+
+Type: `bool`
+
+Default: `false`
+
 ### <a name="input_storage_account"></a> [storage\_account](#input\_storage\_account)
 
 Description: Controls the Storage Account used by the Function App deployment package.

_header.md

@@ -155,6 +155,24 @@ Runnable examples are available under [`examples`](examples):
 
 ### Operations
 
+- Azure Functions Flex Consumption currently returns a corrupted OneDeploy ARM
+  response, causing `azapi_resource.deployment` to fail even when the package is
+  deployed successfully. Set `skip_package_deployment = true` to omit OneDeploy
+  from Terraform and deploy the package out-of-band. `export_api_key` must remain
+  `false` in this mode because Terraform cannot order the host key lookup after
+  an external deployment.
+- The following command shows how to deploy the package after Terraform creates
+  the Function App. Replace the placeholders with the module output and desired
+  Acmebot version. The Azure CLI may still report the response parsing error;
+  verify the resulting deployment separately until the Azure platform issue is
+  resolved.
+
+  ```bash
+  az rest --method PUT \
+    --url "https://management.azure.com<function-app-resource-id>/extensions/onedeploy?api-version=2025-03-01" \
+    --body '{"properties":{"type":"zip","packageUri":"https://github.com/polymind-inc/acmebot/releases/download/v<version>/acmebot.zip","remoteBuild":false}}'
+  ```
+
 - Set `log_analytics_workspace.resource_id` and/or
   `application_insights.resource_id` to reuse existing monitoring resources.
 - Child resources inherit `var.tags` by default and support child-specific tag

main.tf

@@ -204,7 +204,14 @@ resource "azapi_resource" "storage_account_function_app_role_assignment" {
   response_export_values = []
 }
 
+moved {
+  from = azapi_resource.deployment
+  to   = azapi_resource.deployment[0]
+}
+
 resource "azapi_resource" "deployment" {
+  count = var.skip_package_deployment ? 0 : 1
+
   name      = "onedeploy"
   parent_id = module.this.resource_id
   type      = "Microsoft.Web/sites/extensions@2025-03-01"

tests/unit/variables.tftest.hcl

@@ -101,6 +101,35 @@ variables {
 
 run "default_inputs_plan_successfully" {
   command = plan
+
+  assert {
+    condition     = length(azapi_resource.deployment) == 1
+    error_message = "The Acmebot package should be deployed by default."
+  }
+}
+
+run "package_deployment_can_be_skipped" {
+  command = plan
+
+  variables {
+    skip_package_deployment = true
+  }
+
+  assert {
+    condition     = length(azapi_resource.deployment) == 0
+    error_message = "The OneDeploy resource should not be planned when package deployment is skipped."
+  }
+}
+
+run "skipped_package_deployment_cannot_export_api_key" {
+  command = plan
+
+  variables {
+    skip_package_deployment = true
+    export_api_key          = true
+  }
+
+  expect_failures = [var.skip_package_deployment]
 }
 
 run "sovereign_environment_plan_successfully" {

variables.tf

@@ -867,6 +867,18 @@ variable "instance_memory_in_mb" {
   }
 }
 
+variable "skip_package_deployment" {
+  type        = bool
+  description = "Whether to skip deploying the Acmebot package through OneDeploy. When true, the package must be deployed out-of-band and export_api_key must be false."
+  default     = false
+  nullable    = false
+
+  validation {
+    condition     = !var.skip_package_deployment || !var.export_api_key
+    error_message = "export_api_key must be false when skip_package_deployment is true because Terraform cannot order the host key lookup after an out-of-band package deployment."
+  }
+}
+
 variable "export_api_key" {
   type        = bool
   description = "Whether to read and export the default function host key as output."