refactor: updating data sources and resources for fabric cloud router #531

srushti-patl · 2024-01-19T20:12:18Z

Moved fabric_cloud_Router_read schema to fabric_cloud_router data_source.go
Moved fabric_cloud_router_schema to fabric_cloud_router_resource.go
Moved Cloud router dependent methods from fabric_mapping_helpers.go to fabric_cloud_router_resource.go
Updated documentation for fabric cloud router data sources & resources

thogarty · 2024-01-19T22:04:57Z

docs/data-sources/equinix_fabric_cloud_router.md

 - `equinix_asn` (Number) Equinix ASN
 - `href` (String) Fabric Cloud Router URI information
 - `id` (String) The ID of this resource.
 - `location` (Set of Object) Fabric Cloud Router location (see [below for nested schema](#nestedatt--location))
 - `name` (String) Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
 - `notifications` (List of Object) Preferences for notifications on Fabric Cloud Router configuration or status changes (see [below for nested schema](#nestedatt--notifications))
 - `order` (Set of Object) Order information related to this Fabric Cloud Router (see [below for nested schema](#nestedatt--order))
- `package` (Set of Object) Fabric Cloud Router package information (see [below for nested schema](#nestedatt--package))
- `project` (Block Set) Project information (see [below for nested schema](#nestedblock--project))
+- `package` (Set of Object) Fabric Cloud Router location (see [below for nested schema](#nestedatt--package))


The description of this seems to be incorrect. Should refer to package.

equinix/resource_fabric_cloud_router.go

thogarty · 2024-01-19T22:13:19Z

References #423

thogarty

Some changes requested. Good start.

docs/data-sources/equinix_fabric_cloud_router.md

srushti-patl · 2024-01-20T02:10:26Z

I have tested above changes with cloud-router-2-aws example script:

thogarty

Some Changes Requested.

internal/schema/fabric_common_mapping_helpers.go

internal/schema/fabric_common_schemas.go

… internal schema

Signed-off-by: Srushti Patel <[email protected]>

… changes

thogarty

Some minor changes to schema methods and descriptions requested. Please update docs after changes are made. Thank you!

thogarty · 2024-02-06T20:19:24Z

equinix/resource_fabric_cloud_router.go

 )

-func resourceCloudRouter() *schema.Resource {
+func FabricCloudRouterPackageSch() map[string]*schema.Schema {


We can lower case the first letter on this so that it's not exported from the equinix package. It becomes a breaking change when the interface changes like that. All Uppercase Methods/Structs/Variables will be exported automatically.

thogarty · 2024-02-06T20:19:52Z

equinix/resource_fabric_cloud_router.go

+		},
+	}
+}
+func FabricCloudRouterAccountSch() map[string]*schema.Schema {


Lowercase method names because we don't need to export them. As shown in first comment.

thogarty · 2024-02-06T20:20:07Z

equinix/resource_fabric_cloud_router.go

+		},
+	}
+}
+func FabricCloudRouterProjectSch() map[string]*schema.Schema {


Lowercase method names because we don't need to export them. As shown in first comment.

thogarty · 2024-02-06T20:20:11Z

equinix/resource_fabric_cloud_router.go

+	}
+}
+
+func FabricCloudRouterResourceSchema() map[string]*schema.Schema {


Lowercase method names because we don't need to export them. As shown in first comment.

thogarty · 2024-02-06T20:21:06Z

equinix/resource_fabric_cloud_router.go

+			Type:         schema.TypeString,
+			Required:     true,
+			ValidateFunc: validation.StringInSlice([]string{"XF_ROUTER"}, true),
+			Description:  "Defines the FCR type like XF_ROUTER",


This should be updated to a more professional description. Defines the FCR type; i.e. XF_ROUTER

thogarty · 2024-02-06T20:21:35Z

equinix/resource_fabric_cloud_router.go

+		"project": {
+			Type:        schema.TypeSet,
+			Required:    true,
+			Description: "Customer resource hierarchy project information.\nApplicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects",


We can remove the newline \n here. It's ok to have single line descriptions.

thogarty · 2024-02-06T20:22:45Z

equinix/resource_fabric_cloud_router.go

+		"bgp_ipv4_routes_count": {
+			Type:        schema.TypeInt,
+			Computed:    true,
+			Description: "Access point used and maximum number of IPv4 BGP routes",


This Should just be Maximum number of IPv4 BGP Routes. Though I suspect that it's not a maximum and is just the total number of routes currently in use. Double check with: https://developer.equinix.com/docs?page=/dev-docs/fabric/overview

thogarty · 2024-02-06T20:22:47Z

equinix/resource_fabric_cloud_router.go

+		"bgp_ipv6_routes_count": {
+			Type:        schema.TypeInt,
+			Computed:    true,
+			Description: "Access point used and maximum number of IPv6 BGP routes",


This Should just be Maximum number of IPv6 BGP Routes. Though I suspect that it's not a maximum and is just the total number of routes currently in use. Double check with: https://developer.equinix.com/docs?page=/dev-docs/fabric/overview

thogarty · 2024-02-06T20:23:50Z

equinix/resource_fabric_cloud_router.go

+		"distinct_ipv4_prefixes_count": {
+			Type:        schema.TypeInt,
+			Computed:    true,
+			Description: "Number of IPv4 BGP routes in use (including non-distinct prefixes).",


I think this description should be the above, and it seems they are switched. Look in the documentation link shared and update.

thogarty · 2024-02-06T20:24:28Z

equinix/resource_fabric_cloud_router.go

+		"connections_count": {
+			Type:        schema.TypeInt,
+			Computed:    true,
+			Description: "Number of connections associated with this Access point",


There isn't any access point referred to here. We should label it as just a cloud router, but double check with documentation.

It's Total number of connections to the given Fabric Cloud Router instance. I have updated it in the schema description.

thogarty

Ready to ship.

fix: updating data sources and resources for fabric cloud router

2738cb8

srushti-patl requested a review from thogarty January 19, 2024 20:12

srushti-patl temporarily deployed to internal January 19, 2024 20:12 — with GitHub Actions Inactive

srushti-patl had a problem deploying to internal January 19, 2024 20:12 — with GitHub Actions Error

thogarty reviewed Jan 19, 2024

View reviewed changes

equinix/resource_fabric_cloud_router.go Outdated Show resolved Hide resolved

thogarty requested changes Jan 19, 2024

View reviewed changes

docs/data-sources/equinix_fabric_cloud_router.md Outdated Show resolved Hide resolved

fix: moving common methods and schemas for Fabric to internal package

c373e47

srushti-patl had a problem deploying to internal January 20, 2024 02:09 — with GitHub Actions Error

srushti-patl temporarily deployed to internal January 20, 2024 02:09 — with GitHub Actions Inactive

thogarty changed the title ~~fix: updating data sources and resources for fabric cloud router~~ refactor: updating data sources and resources for fabric cloud router Jan 23, 2024

thogarty requested changes Jan 24, 2024

View reviewed changes

internal/schema/fabric_common_mapping_helpers.go Outdated Show resolved Hide resolved

internal/schema/fabric_common_mapping_helpers.go Outdated Show resolved Hide resolved

internal/schema/fabric_common_schemas.go Outdated Show resolved Hide resolved

chore:Updating method name to OrderGoToTerra and renaming package for…

cdae761

… internal schema

srushti-patl requested a review from a team as a code owner January 26, 2024 07:33

srushti-patl had a problem deploying to internal January 26, 2024 07:33 — with GitHub Actions Error

srushti-patl temporarily deployed to internal January 26, 2024 07:33 — with GitHub Actions Inactive

Merge branch 'main' into CXF-83327

0ce2da0

Signed-off-by: Srushti Patel <[email protected]>

srushti-patl had a problem deploying to internal January 26, 2024 22:42 — with GitHub Actions Error

srushti-patl temporarily deployed to internal January 26, 2024 22:42 — with GitHub Actions Inactive

srushti-patl marked this pull request as draft January 26, 2024 23:12

thogarty marked this pull request as ready for review February 5, 2024 22:01

thogarty temporarily deployed to internal February 5, 2024 22:01 — with GitHub Actions Inactive

fix: fixing merge conflicts

b1aff14

srushti-patl temporarily deployed to internal February 5, 2024 23:16 — with GitHub Actions Inactive

fix: updating FCR resources & data sources based on connection schema…

e2d3d95

… changes

srushti-patl requested a review from a team as a code owner February 6, 2024 00:23

srushti-patl temporarily deployed to internal February 6, 2024 01:14 — with GitHub Actions Inactive

thogarty requested changes Feb 6, 2024

View reviewed changes

fix: Updating Schema description & methods names

7d519a2

srushti-patl temporarily deployed to internal February 6, 2024 21:44 — with GitHub Actions Inactive

Merge branch 'main' into CXF-83327

9df955e

srushti-patl temporarily deployed to internal February 6, 2024 21:46 — with GitHub Actions Inactive

thogarty approved these changes Feb 6, 2024

View reviewed changes

Merge branch 'main' into CXF-83327

25527ce

srushti-patl temporarily deployed to internal February 7, 2024 20:09 — with GitHub Actions Inactive

Merge branch 'main' into CXF-83327

90371e7

srushti-patl temporarily deployed to internal February 9, 2024 21:05 — with GitHub Actions Inactive

Merge branch 'main' into CXF-83327

cfb051a

srushti-patl temporarily deployed to internal February 13, 2024 00:55 — with GitHub Actions Inactive

thogarty added the area/resources/fabric Issues related to Fabric and ECX APIs label Feb 13, 2024

srushti-patl added 2 commits February 13, 2024 09:27

misc: fixing merge conflict for fabric_mapper_helper.go

b0fe09c

Merge remote-tracking branch 'origin/CXF-83327' into CXF-83327

a2797d8

srushti-patl temporarily deployed to internal February 13, 2024 17:28 — with GitHub Actions Inactive

ctreatma approved these changes Feb 13, 2024

View reviewed changes

misc: resolving merge conflict in provider.go file

bd7ec3e

srushti-patl temporarily deployed to internal February 13, 2024 21:31 — with GitHub Actions Inactive

srushti-patl merged commit feb1325 into main Feb 13, 2024
6 of 9 checks passed

srushti-patl deleted the CXF-83327 branch February 13, 2024 21:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: updating data sources and resources for fabric cloud router #531

refactor: updating data sources and resources for fabric cloud router #531

srushti-patl commented Jan 19, 2024 •

edited

Loading

thogarty Jan 19, 2024

thogarty commented Jan 19, 2024

thogarty left a comment

srushti-patl commented Jan 20, 2024

thogarty left a comment

thogarty left a comment

thogarty Feb 6, 2024

thogarty Feb 6, 2024

thogarty Feb 6, 2024

thogarty Feb 6, 2024

thogarty Feb 6, 2024

thogarty Feb 6, 2024

thogarty Feb 6, 2024

thogarty Feb 6, 2024

thogarty Feb 6, 2024

thogarty Feb 6, 2024

srushti-patl Feb 6, 2024

thogarty left a comment

refactor: updating data sources and resources for fabric cloud router #531

refactor: updating data sources and resources for fabric cloud router #531

Conversation

srushti-patl commented Jan 19, 2024 • edited Loading

Choose a reason for hiding this comment

thogarty commented Jan 19, 2024

thogarty left a comment

Choose a reason for hiding this comment

srushti-patl commented Jan 20, 2024

thogarty left a comment

Choose a reason for hiding this comment

thogarty left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thogarty left a comment

Choose a reason for hiding this comment

srushti-patl commented Jan 19, 2024 •

edited

Loading