Improve docs around segments and fixed segments

Signed-off-by: Anna Khmelnitsky <[email protected]>
vmware · Feb 15, 2024 · 730330d · 730330d
1 parent 726a519
commit 730330d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/website/docs/guides/faq.html.markdown b/website/docs/guides/faq.html.markdown
@@ -85,3 +85,7 @@ resource "nsxt_policy_group" "test" {
 ## VM tagging and port tagging is not working on big environments
 
 Due to [NSX issue](https://kb.vmware.com/s/article/89437), `vif` API is not working as expected with > 1K objects. Please upgrade your NSX to more recent version.
+
+## I cannot import a segment
+
+The provider offers two types of segments: `nsxt_policy_segment` and `nsxt_policy_fixed_segment`. Those represent separate segment types in NSX: `nsxt_policy_fixed_segment` is always connected to a gateway (policy path of this segment contains the gateway path), and is mostly used in VMC. If your segment import fails, make sure you're trying to import the correct type of segment.
diff --git a/website/docs/r/policy_fixed_segment.html.markdown b/website/docs/r/policy_fixed_segment.html.markdown
@@ -10,8 +10,9 @@ description: A resource to configure a network Segment on specific Tier1 Gateway
 This resource provides a method for the management of Fixed Segments (attached to
 specific Tier-1 Gateway)
 
-This resource is applicable to VMC. For NSX Global Manager and NSX Policy Manager, it
-is recommended to use nsxt_policy_segment resource instead.
+This resource is applicable to VMC. Please use this resource for HCX-created segments.
+For NSX Global Manager and NSX Policy Manager, it is recommended to use `nsxt_policy_segment` 
+resource instead.
 
 ## Example Usage