Update the docs with new edgeDeployment options (#146)

* Docs update * Add examples for edge deployment that show activation to 100 percent of traffic handled * Add new options for Edge Deployment to main.tf as well * Terraform fmting :-) * Few more details --------- Co-authored-by: Vladimir Vuksan <[email protected]>
signalsciences · Mar 24, 2023 · 9754dfe · 9754dfe
1 parent 0288f6a
commit 9754dfe
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 8 deletions.
diff --git a/docs/resources/edge_deployment_service.md b/docs/resources/edge_deployment_service.md
@@ -14,8 +14,10 @@ description: |-
 
 ```terraform
 resource "sigsci_edge_deployment_service" "my-service" {
-  site_short_name = "manual_test"
-  fastly_sid      = "test_sid"
+  site_short_name  = "manual_test"
+  fastly_sid       = "test_sid"
+  activate_version = true
+  percent_enabled  = 100
 }
 ```
 
@@ -27,6 +29,11 @@ resource "sigsci_edge_deployment_service" "my-service" {
 - `fastly_sid` (String) Fastly service ID
 - `site_short_name` (String) Site short name
 
+### Optional
+
+- `activate_version` (Boolean) activate Fastly service version after clone. Possible values are true or false. Defaults to true.
+- `percent_enabled` (Number) percentage of traffic to send to NGWAF@Edge. Possible values are integers values 0 to 100. Defaults to 0.
+
 ### Read-Only
 
 - `id` (String) The ID of this resource.

diff --git a/examples/resources/sigsci_edge_deployment_service/resource.tf b/examples/resources/sigsci_edge_deployment_service/resource.tf
@@ -1,4 +1,6 @@
 resource "sigsci_edge_deployment_service" "my-service" {
-  site_short_name = "manual_test"
-  fastly_sid      = "test_sid"
+  site_short_name  = "manual_test"
+  fastly_sid       = "test_sid"
+  activate_version = true
+  percent_enabled  = 100
 }
diff --git a/main.tf b/main.tf
@@ -394,6 +394,8 @@ resource "sigsci_edge_deployment" "edge" {
 }
 
 resource "sigsci_edge_deployment_service" "edge" {
-  site_short_name = sigsci_site.my-site.short_name
-  fastly_sid      = "[Fastly service id]"
+  site_short_name  = sigsci_site.my-site.short_name
+  fastly_sid       = "[Fastly service id]"
+  activate_version = true
+  percent_enabled  = 100
 }
diff --git a/provider/resource_edge_deployment_service.go b/provider/resource_edge_deployment_service.go
@@ -27,14 +27,14 @@ func resourceEdgeDeploymentService() *schema.Resource {
 
 			"activate_version": {
 				Type:        schema.TypeBool,
-				Description: "activate Fastly service version after clone. Possible values are true or false",
+				Description: "activate Fastly service version after clone. Possible values are true or false. Defaults to true.",
 				Optional:    true,
 				Default:     true,
 			},
 
 			"percent_enabled": {
 				Type:        schema.TypeInt,
-				Description: "percentage of traffic to send to NGWAF@Edge. Possible values are integers values 0 to 100",
+				Description: "percentage of traffic to send to NGWAF@Edge. Possible values are integers values 0 to 100. Defaults to 0.",
 				Optional:    true,
 				Default:     0,
 			},