feat: add a resource for VRF BGP dynamic neighbors #746

ctreatma · 2024-08-01T14:28:54Z

Relates to #697.

This adds a resource for managing VRF BGP dynamic neighbor ranges with accompanying docs. Data sources are left for future contribution.

Fixes #652.

internal/resources/metal/vrf_bgp_dynamic_neighbor/resource.go

internal/resources/metal/vrf_bgp_dynamic_neighbor/datasource_schema.go

ctreatma · 2024-08-01T18:37:49Z

internal/resources/metal/vrf_bgp_dynamic_neighbor/resource_schema.go

+		Description:         "This resource manages BGP dynamic neighbor ranges for an Equinix Metal VRF",
+		MarkdownDescription: "This resource manages BGP dynamic neighbor ranges for an Equinix Metal VRF, but with markdown",


Need better descriptions here, and we do not need MarkdownDescription if we aren't going to include markdown; Description feeds into the docs if MarkdownDescription isn't specified.

internal/resources/metal/vrf_bgp_dynamic_neighbor/resource.go

ctreatma · 2024-08-01T19:31:06Z

internal/resources/metal/vrf_bgp_dynamic_neighbor/resource.go

+	// TODO: should we do something with the neighbor object returned here?
+	// For example: do we need to poll the API until neighbor.GetState() has
+	// as particular value?
+	_, _, err := client.VRFsApi.DeleteBgpDynamicNeighborById(ctx, data.ID.ValueString()).


It looks like the status can be deleting but not deleted, which probably means we need a wait function here to poll the BgpDynamicNeighborsIdGet endpoint until it 404s.

ctreatma · 2024-08-01T19:32:30Z

internal/resources/metal/vrf_bgp_dynamic_neighbor/resource.go

+		return
+	}
+
+	neighbor, _, err := client.VRFsApi.BgpDynamicNeighborsIdGet(ctx, data.ID.ValueString()).


Do we need to wait for a particular status here? If so, do we wait for active or ready? I'm assuming pending is the initial state but I don't see a description in the spec.

cprivitere · 2024-08-21T16:55:51Z

docs/resources/metal_vrf_bgp_dynamic_neighbor.md

+
+# equinix_metal_vrf_bgp_dynamic_neighbor (Resource)
+
+This resource manages BGP dynamic neighbor ranges for an Equinix Metal VRF, but with markdown


"but with markdown"?

Related to this comment thread

codecov-commenter · 2024-08-22T21:11:50Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 68.75000% with 55 lines in your changes missing coverage. Please review.

Project coverage is 52.25%. Comparing base (359dcbb) to head (bef5e56).
Report is 4 commits behind head on main.

Files	Patch %	Lines
...sources/metal/vrf_bgp_dynamic_neighbor/resource.go	52.72%	42 Missing and 10 partials ⚠️
.../resources/metal/vrf_bgp_dynamic_neighbor/model.go	80.00%	2 Missing and 1 partial ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #746      +/-   ##
==========================================
- Coverage   52.38%   52.25%   -0.14%     
==========================================
  Files         154      154              
  Lines       21080    21033      -47     
==========================================
- Hits        11043    10991      -52     
+ Misses       9607     9602       -5     
- Partials      430      440      +10

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ctreatma force-pushed the vrf_bgp_dynamic_range branch from 6fe89e8 to 0832b40 Compare August 1, 2024 14:43