new resource `azurerm_stack_hci_logical_network` #26473

teowa · 2024-06-26T08:56:08Z

Community Note

Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

swagger: https://github.com/Azure/azure-rest-api-specs/blob/1c63635d66ae38cff18045ab416a6572d3e15f6e/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2024-01-01/logicalNetworks.json

Azure doc: https://learn.microsoft.com/en-us/azure-stack/hci/manage/create-logical-networks?tabs=azurecli#prerequisites

The acctest is based on existing custom location, the custom location is generated during HCI deployment which can take more than 3 hours. How to test HCI deployment from scratch is included in PR #25646

PR Checklist

I have followed the guidelines in our Contributing Documentation.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
I have written new tests for my resource or datasource changes & updated any relevent documentation.
I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
(For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

ARM_TEST_STACK_HCI_CUSTOM_LOCATION_ID=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctest-hci-0626/providers/Microsoft.ExtendedLocation/customLocations/customlocation0626 make acctests SERVICE="azurestackhci" TESTARGS="-parallel 5 -run TestAccStackHCILogicalNetwork_" TESTTIMEOUT=2h
==> Checking that code complies with gofmt requirements...
==> Checking that Custom Timeouts are used...
==> Checking that acceptance test packages are used...
TF_ACC=1 go test -v ./internal/services/azurestackhci -parallel 5 -run TestAccStackHCILogicalNetwork_ -timeout 2h -ldflags="-X=github.com/hashicorp/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccStackHCILogicalNetwork_basic
=== PAUSE TestAccStackHCILogicalNetwork_basic
=== RUN   TestAccStackHCILogicalNetwork_update
=== PAUSE TestAccStackHCILogicalNetwork_update
=== RUN   TestAccStackHCILogicalNetwork_requiresImport
=== PAUSE TestAccStackHCILogicalNetwork_requiresImport
=== RUN   TestAccStackHCILogicalNetwork_complete
=== PAUSE TestAccStackHCILogicalNetwork_complete
=== CONT  TestAccStackHCILogicalNetwork_basic
=== CONT  TestAccStackHCILogicalNetwork_complete
=== CONT  TestAccStackHCILogicalNetwork_update
=== CONT  TestAccStackHCILogicalNetwork_requiresImport
--- PASS: TestAccStackHCILogicalNetwork_complete (291.39s)
--- PASS: TestAccStackHCILogicalNetwork_requiresImport (297.44s)
--- PASS: TestAccStackHCILogicalNetwork_basic (297.79s)
--- PASS: TestAccStackHCILogicalNetwork_update (355.81s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/azurestackhci 355.868s

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

new resource azurerm_stack_hci_logical_network [GH-00000]

This is a (please select all that apply):

Bug Fix
New Feature (ie adding a service, resource, or data source)
Enhancement
Breaking Change

Related Issue(s)

Fixes #0000

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

ms-zhenhua

Hi @teowa, Thanks for this PR - I've taken a look through and left some comments inline. If we can fix those up, this should be good to go 👍

ms-zhenhua · 2024-07-02T07:44:43Z

internal/services/azurestackhci/stack_hci_logical_network_resource.go

+			Type:         pluginsdk.TypeString,
+			Required:     true,
+			ForceNew:     true,
+			ValidateFunc: validation.StringIsNotEmpty,


does name have max length and special characters limitation?

validation added.

ms-zhenhua · 2024-07-02T07:51:01Z

internal/services/azurestackhci/stack_hci_logical_network_resource.go

+						ForceNew: true,
+						Elem: &pluginsdk.Resource{
+							Schema: map[string]*pluginsdk.Schema{
+								"name": {


why name is not required?

changed to requred

ms-zhenhua · 2024-07-02T08:29:06Z

internal/services/azurestackhci/stack_hci_logical_network_resource_test.go

+		t.Skipf("skip the test as one or more of below environment variables are not specified: %q", customLocationIdEnv)
+	}
+
+	data.ResourceTest(t, r, []acceptance.TestStep{


please use basic -> complete -> update -> basic to also test add/remove tags.

test updated

ms-zhenhua · 2024-07-02T08:33:45Z

website/docs/r/stack_hci_logical_network.html.markdown

+
+* `custom_location_id` - (Required) The ID of Custom Location where the Azure Stack HCI Logical Network should exist. Changing this forces a new resource to be created.
+
+* `vm_switch_name` - (Required) The name of the network switch used to associate with the Azure Stack HCI Logical Network. Possible switch name can be retrieved following the [Azure documents](https://learn.microsoft.com/azure-stack/hci/manage/create-logical-networks?tabs=azurecli#prerequisites). Changing this forces a new resource to be created.


from the description, it seems should be named as network_switch_name ?

changed to virtual_switch_name and the description to Name of the external virtual switch

ms-zhenhua · 2024-07-02T08:35:02Z

website/docs/r/stack_hci_logical_network.html.markdown

+
+A `subnet` block supports the following:
+
+* `ip_allocation_method` - (Required) IP address allocation method for the subnet. Possible value is `Dynamic` or `Static`. Changing this forces a new resource to be created.


Suggested change

* `ip_allocation_method` - (Required) IP address allocation method for the subnet. Possible value is `Dynamic` or `Static`. Changing this forces a new resource to be created.

* `ip_allocation_method` - (Required) IP address allocation method for the subnet. Possible values are `Dynamic` and `Static`. Changing this forces a new resource to be created.

ms-zhenhua · 2024-07-02T08:37:07Z

website/docs/r/stack_hci_logical_network.html.markdown

+
+* `address_prefix` - (Optional) The address prefix in CIDR notation. Changing this forces a new resource to be created.
+
+* `ip_pool` - (Optional) One or more `ip_pool` block as defined above. Changing this forces a new resource to be created.


why not define the description of ip_pool and route after subnet ?

all the blocks are ranked in alphabetical order

…hange vm_switch_name to virtual_switch_name; update doc

teowa · 2024-07-03T07:45:23Z

Hi @ms-zhenhua , thanks for reviewing this, I have changed the code, please kindly take another look.

--- PASS: TestAccStackHCILogicalNetwork_complete (229.63s)
--- PASS: TestAccStackHCILogicalNetwork_dynamic (294.78s)
--- PASS: TestAccStackHCILogicalNetwork_requiresImport (439.81s)
--- PASS: TestAccStackHCILogicalNetwork_update (504.71s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/azurestackhci 504.757s

ms-zhenhua · 2024-07-03T08:09:58Z

Hi @teowa, thank you for your updates. LGTM~

teowa · 2024-07-03T08:27:56Z

--- PASS: TestAccStackHCILogicalNetwork_dynamic (238.51s)
--- PASS: TestAccStackHCILogicalNetwork_complete (295.82s)
--- PASS: TestAccStackHCILogicalNetwork_requiresImport (443.56s)
--- PASS: TestAccStackHCILogicalNetwork_update (647.05s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/azurestackhci 647.094s

stephybun · 2024-07-09T10:27:44Z

internal/services/azurestackhci/stack_hci_logical_network_resource.go

+			future, err := client.CreateOrUpdate(ctx, id, payload)
+			if err != nil {
+				return fmt.Errorf("performing create %s: %+v", id, err)
+			}
+
+			metadata.SetID(id)
+
+			if err := future.Poller.PollUntilDone(ctx); err != nil {
+				return fmt.Errorf("polling after create %s: %+v", id, err)
+			}


Why aren't we using the combined CreateOrUpdateThenPoll here?

stephybun · 2024-07-09T10:28:36Z

internal/services/azurestackhci/stack_hci_logical_network_resource.go

+
+			parameters := resp.Model
+			if parameters == nil {
+				return fmt.Errorf("retrieving %s: model was nil", *id)


We put the object or property name between back ticks in the error message

Suggested change

return fmt.Errorf("retrieving %s: model was nil", *id)

return fmt.Errorf("retrieving %s: `model` was nil", *id)

stephybun · 2024-07-09T10:30:54Z

internal/services/azurestackhci/stack_hci_logical_network_resource_test.go

+	r := StackHCILogicalNetworkResource{}
+
+	if os.Getenv(customLocationIdEnv) == "" {
+		t.Skipf("skip the test as one or more of below environment variables are not specified: %q", customLocationIdEnv)


I only see one required environment variable for the test:

Suggested change

t.Skipf("skip the test as one or more of below environment variables are not specified: %q", customLocationIdEnv)

t.Skipf("skipping since %q has not been specified", customLocationIdEnv)

stephybun · 2024-07-09T10:31:10Z

internal/services/azurestackhci/stack_hci_logical_network_resource_test.go

+	r := StackHCILogicalNetworkResource{}
+
+	if os.Getenv(customLocationIdEnv) == "" {
+		t.Skipf("skip the test as one or more of below environment variables are not specified: %q", customLocationIdEnv)


Suggested change

t.Skipf("skip the test as one or more of below environment variables are not specified: %q", customLocationIdEnv)

t.Skipf("skipping since %q has not been specified", customLocationIdEnv)

stephybun · 2024-07-09T10:31:44Z

internal/services/azurestackhci/stack_hci_logical_network_resource_test.go

+		return nil, fmt.Errorf("retrieving %s: %+v", *id, err)
+	}
+
+	return utils.Bool(resp.Model != nil), nil


Suggested change

return utils.Bool(resp.Model != nil), nil

return pointer.To(resp.Model != nil), nil

stephybun · 2024-07-09T10:33:06Z

internal/services/azurestackhci/stack_hci_logical_network_resource_test.go

+		if response.WasNotFound(resp.HttpResponse) {
+			return utils.Bool(false), nil
+		}


This isn't a typical pattern in the Exists check for tests? If we get any error kind of error from getting the resource here we should just return it

Suggested change

if response.WasNotFound(resp.HttpResponse) {

return utils.Bool(false), nil

}

stephybun · 2024-07-09T10:35:02Z

website/docs/r/stack_hci_logical_network.html.markdown

+
+* `custom_location_id` - (Required) The ID of Custom Location where the Azure Stack HCI Logical Network should exist. Changing this forces a new resource to be created.
+
+* `virtual_switch_name` - (Required) The name of the virtual switch on the cluster used to associate with the Azure Stack HCI Logical Network. Possible switch name can be retrieved following the [Azure documents](https://learn.microsoft.com/azure-stack/hci/manage/create-logical-networks?tabs=azurecli#prerequisites). Changing this forces a new resource to be created.


Suggested change

* `virtual_switch_name` - (Required) The name of the virtual switch on the cluster used to associate with the Azure Stack HCI Logical Network. Possible switch name can be retrieved following the [Azure documents](https://learn.microsoft.com/azure-stack/hci/manage/create-logical-networks?tabs=azurecli#prerequisites). Changing this forces a new resource to be created.

* `virtual_switch_name` - (Required) The name of the virtual switch on the cluster used to associate with the Azure Stack HCI Logical Network. Possible switch names can be retrieved by following this [Azure guide](https://learn.microsoft.com/azure-stack/hci/manage/create-logical-networks?tabs=azurecli#prerequisites). Changing this forces a new resource to be created.

stephybun · 2024-07-09T10:36:16Z

website/docs/r/stack_hci_logical_network.html.markdown

+
+* `route` - (Optional) One or more `route` block as defined above. Changing this forces a new resource to be created.
+
+* `vlan_id` - (Optional) VLAN ID for the Logical Network. Changing this forces a new resource to be created.


Suggested change

* `vlan_id` - (Optional) VLAN ID for the Logical Network. Changing this forces a new resource to be created.

* `vlan_id` - (Optional) The VLAN ID for the Logical Network. Changing this forces a new resource to be created.

teowa · 2024-07-23T06:16:57Z

--- PASS: TestAccStackHCILogicalNetwork_dynamic (274.18s)
--- PASS: TestAccStackHCILogicalNetwork_complete (291.81s)
--- PASS: TestAccStackHCILogicalNetwork_requiresImport (445.89s)
--- PASS: TestAccStackHCILogicalNetwork_update (681.67s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/azurestackhci 681.710s

stephybun

Thanks @teowa LGTM 👍

* new resource stack_hci_logical_network * validate name property; update test; change route name to required; change vm_switch_name to virtual_switch_name; update doc * fix update test * use createThenPoll; fix error message; fix doc * update doc

github-actions · 2024-08-25T02:12:08Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

new resource stack_hci_logical_network

472faff

github-actions bot added documentation service/azure-stack-hci size/XL labels Jun 26, 2024

teowa marked this pull request as draft June 26, 2024 09:02

ms-zhenhua suggested changes Jul 2, 2024

View reviewed changes

github-actions bot added the waiting-response label Jul 2, 2024

validate name property; update test; change route name to required; c…

3a4e5aa

…hange vm_switch_name to virtual_switch_name; update doc

github-actions bot removed the waiting-response label Jul 3, 2024

fix update test

6e38eae

ms-zhenhua approved these changes Jul 3, 2024

View reviewed changes

teowa marked this pull request as ready for review July 3, 2024 08:28

stephybun requested changes Jul 9, 2024

View reviewed changes

github-actions bot added the waiting-response label Jul 9, 2024

use createThenPoll; fix error message; fix doc

2214a62

github-actions bot removed the waiting-response label Jul 11, 2024

update doc

d80ab46

stephybun added the new-resource label Jul 25, 2024

stephybun approved these changes Jul 25, 2024

View reviewed changes

stephybun merged commit edd8054 into hashicorp:main Jul 25, 2024
34 checks passed

github-actions bot added this to the v3.114.0 milestone Jul 25, 2024

stephybun added a commit that referenced this pull request Jul 25, 2024

Update for #26473 #26761

2cd6497

lonegunmanb pushed a commit to lonegunmanb/terraform-provider-azurerm that referenced this pull request Aug 5, 2024

Update for hashicorp#26473 hashicorp#26761

3779cdc

github-actions bot locked as resolved and limited conversation to collaborators Aug 25, 2024


		* `custom_location_id` - (Required) The ID of Custom Location where the Azure Stack HCI Logical Network should exist. Changing this forces a new resource to be created.

		* `vm_switch_name` - (Required) The name of the network switch used to associate with the Azure Stack HCI Logical Network. Possible switch name can be retrieved following the [Azure documents](https://learn.microsoft.com/azure-stack/hci/manage/create-logical-networks?tabs=azurecli#prerequisites). Changing this forces a new resource to be created.


		A `subnet` block supports the following:

		* `ip_allocation_method` - (Required) IP address allocation method for the subnet. Possible value is `Dynamic` or `Static`. Changing this forces a new resource to be created.


		* `address_prefix` - (Optional) The address prefix in CIDR notation. Changing this forces a new resource to be created.

		* `ip_pool` - (Optional) One or more `ip_pool` block as defined above. Changing this forces a new resource to be created.

	return fmt.Errorf("retrieving %s: model was nil", *id)
	return fmt.Errorf("retrieving %s: `model` was nil", *id)

	t.Skipf("skip the test as one or more of below environment variables are not specified: %q", customLocationIdEnv)
	t.Skipf("skipping since %q has not been specified", customLocationIdEnv)

	return utils.Bool(resp.Model != nil), nil
	return pointer.To(resp.Model != nil), nil

	if response.WasNotFound(resp.HttpResponse) {
	return utils.Bool(false), nil
	}


		* `custom_location_id` - (Required) The ID of Custom Location where the Azure Stack HCI Logical Network should exist. Changing this forces a new resource to be created.

		* `virtual_switch_name` - (Required) The name of the virtual switch on the cluster used to associate with the Azure Stack HCI Logical Network. Possible switch name can be retrieved following the [Azure documents](https://learn.microsoft.com/azure-stack/hci/manage/create-logical-networks?tabs=azurecli#prerequisites). Changing this forces a new resource to be created.


		* `route` - (Optional) One or more `route` block as defined above. Changing this forces a new resource to be created.

		* `vlan_id` - (Optional) VLAN ID for the Logical Network. Changing this forces a new resource to be created.

	* `vlan_id` - (Optional) VLAN ID for the Logical Network. Changing this forces a new resource to be created.
	* `vlan_id` - (Optional) The VLAN ID for the Logical Network. Changing this forces a new resource to be created.

new resource azurerm_stack_hci_logical_network #26473

new resource azurerm_stack_hci_logical_network #26473

Conversation

teowa commented Jun 26, 2024

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Related Issue(s)

ms-zhenhua 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

Choose a reason for hiding this comment

teowa commented Jul 3, 2024 • edited Loading

ms-zhenhua commented Jul 3, 2024

teowa commented Jul 3, 2024

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

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

teowa commented Jul 23, 2024

stephybun left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 25, 2024

new resource `azurerm_stack_hci_logical_network` #26473

new resource `azurerm_stack_hci_logical_network` #26473

teowa commented Jul 3, 2024 •

edited

Loading