docs: Deprecate ecx_ Terraform Resources (#445)

* Add deprecation messages to ecx_ terraform resources using Fabric v3 API SDK * Add docs update for deprecated resources
equinix · Nov 15, 2023 · 4131665 · 4131665
2 parents 60a89b8 + 9b65054
commit 4131665
Show file tree

Hide file tree

Showing 10 changed files with 40 additions and 15 deletions.
diff --git a/docs/data-sources/equinix_ecx_l2_sellerprofile.md b/docs/data-sources/equinix_ecx_l2_sellerprofile.md
@@ -2,6 +2,10 @@
 subcategory: "Fabric"
 ---
 
+# DEPRECATED RESOURCE
+
+End of Life will be June 30th, 2024. Use equinix_fabric_service_profile instead.
+
 # equinix_ecx_l2_sellerprofile (Data Source)
 
 Use this data source to get details of Equinix Fabric layer 2 seller profile with a given name

diff --git a/docs/data-sources/equinix_ecx_l2_sellerprofiles.md b/docs/data-sources/equinix_ecx_l2_sellerprofiles.md
@@ -2,6 +2,10 @@
 subcategory: "Fabric"
 ---
 
+# DEPRECATED RESOURCE
+
+End of Life will be June 30th, 2024. Use equinix_fabric_service_profiles instead.
+
 # equinix_ecx_l2_sellerprofiles (Data Source)
 
 Use this data source to get details of available Equinix Fabric layer 2 seller profiles. It is

diff --git a/docs/data-sources/equinix_ecx_port.md b/docs/data-sources/equinix_ecx_port.md
@@ -2,6 +2,10 @@
 subcategory: "Fabric"
 ---
 
+# DEPRECATED RESOURCE
+
+End of Life will be June 30th, 2024. Use equinix_fabric_port and equinix_fabric_ports instead.
+
 # equinix_ecx_port (Data Source)
 
 Use this data source to get details of Equinix Fabric port with a given name.

diff --git a/docs/resources/equinix_ecx_l2_connection.md b/docs/resources/equinix_ecx_l2_connection.md
@@ -2,6 +2,10 @@
 subcategory: "Fabric"
 ---
 
+# DEPRECATED RESOURCE
+
+End of Life will be June 30th, 2024. Use equinix_fabric_connection instead.
+
 # equinix_ecx_l2_connection (Resource)
 
 Resource `equinix_ecx_l2_connection` allows creation and management of Equinix Fabric

diff --git a/docs/resources/equinix_ecx_l2_serviceprofile.md b/docs/resources/equinix_ecx_l2_serviceprofile.md
@@ -2,6 +2,10 @@
 subcategory: "Fabric"
 ---
 
+# DEPRECATED RESOURCE
+
+End of Life will be June 30th, 2024. Use equinix_fabric_service_profile instead.
+
 # equinix_ecx_l2_serviceprofile (Resource)
 
 Resource `equinix_ecx_l2_serviceprofile` is used to manage layer 2 service profiles

diff --git a/equinix/data_source_ecx_l2_sellerprofile.go b/equinix/data_source_ecx_l2_sellerprofile.go
@@ -77,9 +77,10 @@ var ecxL2SellerProfileAdditionalInfosDescriptions = map[string]string{
 
 func dataSourceECXL2SellerProfile() *schema.Resource {
 	return &schema.Resource{
-		ReadContext: dataSourceECXL2SellerProfileRead,
-		Description: "Use this data source to get details of Equinix Fabric layer 2 seller profile with a given name and / or organization",
-		Schema:      createECXL2SellerProfileSchema(),
+		DeprecationMessage: "This resource is deprecated. End of Life will be June 30th, 2024. Use equinix_fabric_service_profile instead.",
+		ReadContext:        dataSourceECXL2SellerProfileRead,
+		Description:        "Use this data source to get details of Equinix Fabric layer 2 seller profile with a given name and / or organization",
+		Schema:             createECXL2SellerProfileSchema(),
 	}
 }
 

diff --git a/equinix/data_source_ecx_l2_sellerprofiles.go b/equinix/data_source_ecx_l2_sellerprofiles.go
@@ -35,8 +35,9 @@ var ecxL2SellerProfilesDescriptions = map[string]string{
 
 func dataSourceECXL2SellerProfiles() *schema.Resource {
 	return &schema.Resource{
-		ReadContext: dataSourceECXL2SellerProfilesRead,
-		Description: "Use this data source to get list of Equinix Fabric layer 2 seller profiles",
+		DeprecationMessage: "This resource is deprecated. End of Life will be June 30th, 2024. Use equinix_fabric_service_profiles instead.",
+		ReadContext:        dataSourceECXL2SellerProfilesRead,
+		Description:        "Use this data source to get list of Equinix Fabric layer 2 seller profiles",
 		Schema: map[string]*schema.Schema{
 			ecxL2SellerProfilesSchemaNames["NameRegex"]: {
 				Type:         schema.TypeString,

diff --git a/equinix/data_source_ecx_port.go b/equinix/data_source_ecx_port.go
@@ -40,8 +40,9 @@ var ecxPortDescriptions = map[string]string{
 
 func dataSourceECXPort() *schema.Resource {
 	return &schema.Resource{
-		ReadContext: dataSourceECXPortRead,
-		Description: "Use this data source to get details of Equinix Fabric port with a given name",
+		DeprecationMessage: "This resource is deprecated. End of Life will be June 30th, 2024. Use equinix_fabric_port and equinix_fabric_ports instead.",
+		ReadContext:        dataSourceECXPortRead,
+		Description:        "Use this data source to get details of Equinix Fabric port with a given name",
 		Schema: map[string]*schema.Schema{
 			ecxPortSchemaNames["UUID"]: {
 				Type:        schema.TypeString,

diff --git a/equinix/resource_ecx_l2_connection.go b/equinix/resource_ecx_l2_connection.go
@@ -129,10 +129,11 @@ type (
 
 func resourceECXL2Connection() *schema.Resource {
 	return &schema.Resource{
-		CreateContext: resourceECXL2ConnectionCreate,
-		ReadContext:   resourceECXL2ConnectionRead,
-		UpdateContext: resourceECXL2ConnectionUpdate,
-		DeleteContext: resourceECXL2ConnectionDelete,
+		DeprecationMessage: "This resource is deprecated. End of Life will be June 30th, 2024. Use equinix_fabric_connection instead.",
+		CreateContext:      resourceECXL2ConnectionCreate,
+		ReadContext:        resourceECXL2ConnectionRead,
+		UpdateContext:      resourceECXL2ConnectionUpdate,
+		DeleteContext:      resourceECXL2ConnectionDelete,
 		Importer: &schema.ResourceImporter{
 			StateContext: func(ctx context.Context, d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
 				// The expected ID to import redundant connections is '(primaryID):(secondaryID)', e.g.,

diff --git a/equinix/resource_ecx_l2_serviceprofile.go b/equinix/resource_ecx_l2_serviceprofile.go
@@ -105,10 +105,11 @@ var ecxL2ServiceProfileSpeedBandDescriptions = map[string]string{
 
 func resourceECXL2ServiceProfile() *schema.Resource {
 	return &schema.Resource{
-		CreateContext: resourceECXL2ServiceProfileCreate,
-		ReadContext:   resourceECXL2ServiceProfileRead,
-		UpdateContext: resourceECXL2ServiceProfileUpdate,
-		DeleteContext: resourceECXL2ServiceProfileDelete,
+		DeprecationMessage: "This resource is deprecated. End of Life will be June 30th, 2024. Use equinix_fabric_service_profile instead.",
+		CreateContext:      resourceECXL2ServiceProfileCreate,
+		ReadContext:        resourceECXL2ServiceProfileRead,
+		UpdateContext:      resourceECXL2ServiceProfileUpdate,
+		DeleteContext:      resourceECXL2ServiceProfileDelete,
 		Importer: &schema.ResourceImporter{
 			State: schema.ImportStatePassthrough,
 		},