(Doc) Updated documentation to v 2.7.7 (#310)

zscaler · May 23, 2023 · 28b039a · 28b039a
1 parent 29e59c1
commit 28b039a
Show file tree

Hide file tree

Showing 3 changed files with 88 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,43 @@
 # Changelog
 
+## 2.7.7 (xx, xx 2023) - Unreleased
+
+### Notes
+
+- Release date: **(xx, xx 2023)**
+- Supported Terraform version: **v1.x**
+
+### Bug Fixes
+
+- [PR #309](https://github.com/zscaler/terraform-provider-zpa/pull/309) Updated provider to Zscaler SDK GO v1.5.2. The update added exception handling within the ZPA API Client to deal with simultaneous DB requests, which were affecting the ZPA Policy Access rule order creation.
+
+⚠️ **WARNING:** Due to API restrictions, we recommend to limit the number of requests to ONE, when configuring the following resources:
+
+- ``zpa_policy_access_rule``
+- ``zpa_policy_inspection_rule``
+- ``zpa_policy_timeout_rule``
+- ``zpa_policy_forwarding_rule``
+- ``zpa_policy_isolation_rule``
+  - Internal References:
+    - [ET-53585](https://jira.corp.zscaler.com/browse/ET-53585)
+    - [ET-48860](https://confluence.corp.zscaler.com/display/ET/ET-48860+incorrect+rules+order)
+
+Terraform uses goroutines to speed up deployment, but the number of parallel
+operations it launches exceeds [what is recommended](https://help.zscaler.com/zpa/about-rate-limiting).
+When configuring ZPA Policies we recommend to limit the number of concurrent API calls to ONE. This limit ensures that there is no performance impact during the provisioning of large Terraform configurations.
+
+This recommendation applies to the following resources:
+
+- ``zpa_policy_access_rule``
+- ``zpa_policy_inspection_rule``
+- ``zpa_policy_timeout_rule``
+- ``zpa_policy_forwarding_rule``
+- ``zpa_policy_isolation_rule``
+
+In order to accomplish this, make sure you set the
+[parallelism](https://www.terraform.io/cli/commands/apply#parallelism-n) value at or
+below this limit to prevent performance impacts.
+
 ## 2.7.6 (May, 20 2023)
 
 ### Notes

diff --git a/docs/guides/release-notes.md b/docs/guides/release-notes.md
@@ -12,10 +12,39 @@ Track all ZPA Terraform provider's releases. New resources, features, and bug fi
 
 ---
 
-``Last updated: v2.7.6``
+``Last updated: v2.7.7``
 
 ---
 
+- [PR #309](https://github.com/zscaler/terraform-provider-zpa/pull/309) Updated provider to Zscaler SDK GO v1.5.2. The update added exception handling within the ZPA API Client to deal with simultaneous DB requests, which were affecting the ZPA Policy Access rule order creation.
+
+⚠️ **WARNING:** Due to API restrictions, we recommend to limit the number of requests to ONE, when configuring the following resources:
+
+- ``zpa_policy_access_rule``
+- ``zpa_policy_inspection_rule``
+- ``zpa_policy_timeout_rule``
+- ``zpa_policy_forwarding_rule``
+- ``zpa_policy_isolation_rule``
+  - Internal References:
+    - [ET-53585](https://jira.corp.zscaler.com/browse/ET-53585)
+    - [ET-48860](https://confluence.corp.zscaler.com/display/ET/ET-48860+incorrect+rules+order)
+
+Terraform uses goroutines to speed up deployment, but the number of parallel
+operations it launches exceeds [what is recommended](https://help.zscaler.com/zpa/about-rate-limiting).
+When configuring ZPA Policies we recommend to limit the number of concurrent API calls to ONE. This limit ensures that there is no performance impact during the provisioning of large Terraform configurations.
+
+This recommendation applies to the following resources:
+
+- ``zpa_policy_access_rule``
+- ``zpa_policy_inspection_rule``
+- ``zpa_policy_timeout_rule``
+- ``zpa_policy_forwarding_rule``
+- ``zpa_policy_isolation_rule``
+
+In order to accomplish this, make sure you set the
+[parallelism](https://www.terraform.io/cli/commands/apply#parallelism-n) value at or
+below this limit to prevent performance impacts.
+
 ## 2.7.6 (May, 20 2023)
 
 ### Notes

diff --git a/docs/index.md b/docs/index.md
@@ -68,6 +68,26 @@ resouce "zpa_application_segment" "app_segment" {
 }
 ```
 
+## Terraform / Zscaler Private Access Interaction
+
+### Parallelism
+
+Terraform uses goroutines to speed up deployment, but the number of parallel
+operations it launches exceeds [what is recommended](https://help.zscaler.com/zpa/about-rate-limiting).
+When configuring ZPA Policies we recommend to limit the number of concurrent API calls to ONE. This limit ensures that there is no performance impact during the provisioning of large Terraform configurations.
+
+This recommendation applies to the following resources:
+
+- ``zpa_policy_access_rule``
+- ``zpa_policy_inspection_rule``
+- ``zpa_policy_timeout_rule``
+- ``zpa_policy_forwarding_rule``
+- ``zpa_policy_isolation_rule``
+
+In order to accomplish this, make sure you set the
+[parallelism](https://www.terraform.io/cli/commands/apply#parallelism-n) value at or
+below this limit to prevent performance impacts.
+
 ## Authentication
 
 The ZPA provider offers various means of providing credentials for authentication. The following methods are supported: