new resource `azurerm_virtual_machine_run_command` #23377

teowa · 2023-09-25T10:07:56Z

Ref:

Test:

--- PASS: TestAccVirtualMachineRunCommand_complete (333.26s)
--- PASS: TestAccVirtualMachineRunCommand_basic (358.17s)
--- PASS: TestAccVirtualMachineRunCommand_requiresImport (379.89s)
--- PASS: TestAccVirtualMachineRunCommand_update (476.46s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/compute       476.492s

resolves #20935

katbyte

Thanks for the PR @teowa - i'm wondering if this makes sense in terraform/how this works?

given it "runs a command" how do you know when to run it? does it run every plan apply? once?

teowa · 2023-10-19T03:02:20Z

Thanks for the PR @teowa - i'm wondering if this makes sense in terraform/how this works?

given it "runs a command" how do you know when to run it? does it run every plan apply? once?

The command will run after the resource is being applied (a PUT being sent) and the provider will poll until it is finished. Implement this in terraform, users can make use of below features of the runCommand from doc:

Parallel execution of multiple scripts
Sequential execution of scripts
User specified script timeout
Support for long running (hours/days) scripts
Passing secrets (parameters, passwords) in a secure manner

katbyte · 2023-11-07T02:28:00Z

The command will run after every apply and the provider will poll until it is finished

so every apply this runs? no matter how many times it has run before? again i'm not sure if this is a suitable API for terraform as it is triggering something, every time, and there is no feeedback on if it succeeded or state tos ave?

tombuildsstuff

hey @teowa

I've taken a quick look through and left some comments inline, but I'd agree with @katbyte that we need to determine whether this resource makes sense to support in Terraform.

The API appears to be mostly intended for interactive usage (e.g. through the Azure CLI/Portal) for one-of commands rather than for something intended to stick around long-term - as such whilst it's possible to support that in Terraform, I'm not sure it makes sense as a Terraform resource.

In addition the API interacts with the VM Agent, which is also used by the VM Extension resource - and is a major source of issues for end-users today (due the behaviour of both the VM Agent and the the Azure API, not validating the payload/surfacing errors) - as such I'm also concerned this resource may be similarly problematic for end-users/a support burden.

As such whilst I can understand this API being used interactively, would you be able to elaborate on the specific use-cases we're looking to support here?

Thanks!

tombuildsstuff · 2023-11-27T09:19:05Z

internal/services/compute/virtual_machine_run_command_resource.go

+		"async_execution_enabled": {
+			Type:     pluginsdk.TypeBool,
+			Optional: true,
+			Default:  false,
+		},


This would violate a key principal of Terraform - that we don't mark a resource as Succeeded until it's finished provisioning - so we'd need to remove this.

Make sense, now the property is hide in TF schema. And we set the flag to false in request.

@tombuildsstuff async_execution is pretty important for this resource because if you're setting up a sql vm, it could take hours to restore backups. That's why the AzureRM API supports async_execution. As currently implemented, if the script takes hours to run then terraform has to run for hours, eating up minutes on our CI/CD system and tying up agents. To me, it seems perfectly valid to consider the resource provisioned if the run command is created, even if it is still running.

tombuildsstuff · 2023-11-27T09:20:21Z

internal/services/compute/virtual_machine_run_command_resource.go

+		"timeout_in_seconds": {
+			Type:         pluginsdk.TypeInt,
+			Optional:     true,
+			ValidateFunc: validation.IntAtLeast(1),
+		},


Terraform has timeouts which are used for this purpose, whilst I understand this value is being passed to the API - it's another example of why this resource probably isn't a fit for Terraform.

this property is hide in schema now, in API this field is set to the resource timeout for create/update, which is also customizable through timeouts block.

tombuildsstuff · 2023-11-27T09:21:42Z

internal/services/compute/virtual_machine_run_command_resource.go

+
+func (r VirtualMachineRunCommandResource) Attributes() map[string]*pluginsdk.Schema {
+	return map[string]*pluginsdk.Schema{
+		"instance_view": {


What would users do with this output? The output field perhaps could be useful, but if the exit code is non-zero, presumably the resource would be marked as failed (as is common in other tooling)?

The resource will run the script in VM when Create/Update is triggered. And if script fails, Azire API will return error but the instance still exists in Azure, with non-zero exitcode and error messages inside the instance_view block. The problem is: if save the failed instance in Terraform state, the resource will be marked as taint thus lead to force replacement during next apply.

Terraform will perform the following actions: # azurerm_virtual_machine_run_command.example03 is tainted, so must be replaced

~~Sometimes the API has some issue when performing replacement on same ID~~. Cannot reproduce it stablelly.

Added a receate test for this case where a wrong script was submitted and then be corrected.

Yvand · 2023-11-27T12:50:55Z

I monitor this request and I would like to support it for the following reasons:

This runCommands is a resource of its own right in ARM and Bicep
Functionally, runCommands is equivalent to the existing resource azurerm_virtual_machine_extension, which also runs a (more sophisticated) script in the target VM

On my side, I need this resource azurerm_virtual_machine_run_command to run a PowerShell script that sets a property, so that resource azurerm_virtual_machine_extension can run successfully.
Today, my workaround is to use the AzAPI Provider. Adding this resource would allow me to remove the dependency on this provider.

teowa · 2023-12-01T08:34:27Z

Hi team, I have refined the code to make it more fit for Terraform schema. Please kindly take another look.

The resource will run script on the VM when Create/Update is triggered.
The resource will emit error if the script execution fails but will leave a instance, to handle this, I modified the Create process to create -> metadata.SetID(id) -> poll the long running operation, in this way if user want to correct the wrong script and then run Terraform apply they don't need to manully import it. And the instance will be mark as taint and be recreated.

--- PASS: TestAccVirtualMachineRunCommand_storageBlobSystemIdentity (300.88s)
--- PASS: TestAccVirtualMachineRunCommand_requiresImport (318.65s)
--- PASS: TestAccVirtualMachineRunCommand_sourceCommandId (396.41s)
--- PASS: TestAccVirtualMachineRunCommand_complete (408.56s)
--- PASS: TestAccVirtualMachineRunCommand_storageBlobSAS (417.41s)
--- PASS: TestAccVirtualMachineRunCommand_basic (451.53s)
--- PASS: TestAccVirtualMachineRunCommand_recreate (462.59s)
--- PASS: TestAccVirtualMachineRunCommand_update (494.90s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/compute       494.920s

katbyte

LGTM ⛵

<Actions> <action id="f410411e63aff4bb73a81c2aec1d373cf8a903e63b30dee2006b0030d8a94cc8"> <h3>Bump Terraform `azurerm` provider version</h3> <details id="1d9343c012f5434ac9fe8a98135bae3667b399259be16d9b14302ea3bd424a24"> <summary>Update Terraform lock file</summary> <p>"hashicorp/azurerm" updated from "3.87.0" to "3.88.0" in file ".terraform.lock.hcl"</p> <details> <summary>3.88.0</summary> <pre>Changelog retrieved from:
	https://github.com/hashicorp/terraform-provider-azurerm/releases/tag/v3.88.0
FEATURES:

* New Data Source: `azurerm_nginx_deployment` ([#24492](hashicorp/terraform-provider-azurerm#24492 New Resource: `azurerm_spring_cloud_dynatrace_application_performance_monitoring` ([#23889](hashicorp/terraform-provider-azurerm#23889 New Resource: `azurerm_virtual_machine_run_command` ([#23377](https://github.com/hashicorp/terraform-provider-azurerm/issues/23377))

ENHANCEMENTS:

* dependencies: updating to `v0.20240117.1163544` of `github.com/hashicorp/go-azure-sdk` ([#24481](hashicorp/terraform-provider-azurerm#24481 dependencies: updating to `v0.65.1` of `github.com/hashicorp/go-azure-helpers` ([#24479](hashicorp/terraform-provider-azurerm#24479 `datashare`: updating to use the base layer from `hashicorp/go-azure-sdk` rather than `Azure/go-autorest` ([#24481](hashicorp/terraform-provider-azurerm#24481 `kusto`: updating to use the base layer from `hashicorp/go-azure-sdk` rather than `Azure/go-autorest` ([#24477](hashicorp/terraform-provider-azurerm#24477 Data Source: `azurerm_application_gateway` - support for the `trusted_client_certificate.data` property ([#24474](hashicorp/terraform-provider-azurerm#24474 `azurerm_service_plan`: refactoring to use `hashicorp/go-azure-sdk` ([#24483](hashicorp/terraform-provider-azurerm#24483 `azurerm_container_group` - support for the `priority` property ([#24374](hashicorp/terraform-provider-azurerm#24374 `azurerm_mssql_managed_database` - support for the `point_in_time_restore` property ([#24535](hashicorp/terraform-provider-azurerm#24535 `azurerm_mssql_managed_instance` - now exports the `dns_zone` attribute ([#24435](hashicorp/terraform-provider-azurerm#24435 `azurerm_linux_web_app_slot` - support for setting `python_version` to `3.12` ([#24363](hashicorp/terraform-provider-azurerm#24363 `azurerm_linux_web_app` - support for setting `python_version` to `3.12` ([#24363](hashicorp/terraform-provider-azurerm#24363 `azurerm_linux_function_app_slot` - support for setting `python_version` to `3.12` ([#24363](hashicorp/terraform-provider-azurerm#24363 `azurerm_linux_function_app` - support for setting `python_version` to `3.12` ([#24363](https://github.com/hashicorp/terraform-provider-azurerm/issues/24363))

BUG FIXES:

* `azurerm_application_gateway` - the `components` property within the `url` block is no longer computed ([#24480](hashicorp/terraform-provider-azurerm#24480 `azurerm_cdn_frontdoor_route` - prevent an issue where `cdn_frontdoor_origin_path` gets removed on update if unchanged. ([#24488](hashicorp/terraform-provider-azurerm#24488 `azurerm_cognitive_account` - fixing support for the `DC0` SKU ([#24526](https://github.com/hashicorp/terraform-provider-azurerm/issues/24526))


</pre> </details> </details> <a href="https://infra.ci.jenkins.io/job/terraform-jobs/job/azure/job/main/1017/">Jenkins pipeline link</a> </action> </Actions> --- <table> <tr> <td width="77"> <img src="https://www.updatecli.io/images/updatecli.png" alt="Updatecli logo" width="50" height="50"> </td> <td> <p> Created automatically by <a href="https://www.updatecli.io/">Updatecli</a> </p> <details><summary>Options:</summary> <br /> <p>Most of Updatecli configuration is done via <a href="https://www.updatecli.io/docs/prologue/quick-start/">its manifest(s)</a>.</p> <ul> <li>If you close this pull request, Updatecli will automatically reopen it, the next time it runs.</li> <li>If you close this pull request and delete the base branch, Updatecli will automatically recreate it, erasing all previous commits made.</li> </ul> <p> Feel free to report any issues at <a href="https://github.com/updatecli/updatecli/issues">github.com/updatecli/updatecli</a>.<br /> If you find this tool useful, do not hesitate to star <a href="https://github.com/updatecli/updatecli/stargazers">our GitHub repository</a> as a sign of appreciation, and/or to tell us directly on our <a href="https://matrix.to/#/#Updatecli_community:gitter.im">chat</a>! </p> </details> </td> </tr> </table> Co-authored-by: Jenkins Infra Bot (updatecli) <[email protected]>

MoussaBangre · 2024-01-25T12:46:39Z

Just interested to know how does the connection works in case of ssh into the target vm !

github-actions · 2024-05-03T02:09:16Z

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.

github-actions bot added documentation dependencies size/XL waiting-response and removed waiting-response labels Sep 25, 2023

katbyte requested changes Oct 17, 2023

View reviewed changes

github-actions bot added waiting-response and removed waiting-response labels Oct 17, 2023

katbyte added the waiting-response label Nov 7, 2023

teowa marked this pull request as draft November 17, 2023 11:05

github-actions bot added waiting-response and removed waiting-response labels Nov 27, 2023

tombuildsstuff suggested changes Nov 27, 2023

View reviewed changes

tombuildsstuff added thinking question and removed thinking labels Nov 27, 2023

teowa added 7 commits November 28, 2023 10:58

run cmd

8a71d27

fix

9f03a98

switch to use commonids

c8750a1

fix doc

e166df0

deploy fail when cmd fail

6c5b86e

test storage SAS

6295222

fix lint

dd16369

teowa force-pushed the vm_run_cmd branch from 05f7352 to dd16369 Compare November 28, 2023 11:14

github-actions bot removed the waiting-response label Nov 28, 2023

remove timeout_in_seconds and async_execution; setID before poll

febd13a

github-actions bot added the waiting-response label Nov 29, 2023

fix lint

01a1d2c

github-actions bot removed the waiting-response label Nov 29, 2023

add recreate test

38d49e9

github-actions bot added the waiting-response label Dec 1, 2023

teowa added 2 commits December 1, 2023 08:22

Merge branch 'main' into vm_run_cmd

68f90c5

go mod vendor

e898f8a

github-actions bot removed the waiting-response label Dec 1, 2023

add comment

37a0a57

teowa marked this pull request as ready for review December 1, 2023 08:34

katbyte approved these changes Jan 18, 2024

View reviewed changes

katbyte merged commit 6d5439d into hashicorp:main Jan 18, 2024
24 checks passed

github-actions bot added this to the v3.88.0 milestone Jan 18, 2024

katbyte added a commit that referenced this pull request Jan 18, 2024

Update CHANGELOG.md #23377

3625a36

tombuildsstuff mentioned this pull request Apr 2, 2024

Support for async_execution in azurerm_virtual_machine_run_command #25487

Closed

1 task

github-actions bot locked as resolved and limited conversation to collaborators May 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

new resource `azurerm_virtual_machine_run_command` #23377

new resource `azurerm_virtual_machine_run_command` #23377

teowa commented Sep 25, 2023

katbyte left a comment

teowa commented Oct 19, 2023 •

edited

Loading

katbyte commented Nov 7, 2023

tombuildsstuff left a comment

tombuildsstuff Nov 27, 2023

teowa Nov 29, 2023

gburkecw Apr 2, 2024

tombuildsstuff Nov 27, 2023

teowa Nov 29, 2023 •

edited

Loading

tombuildsstuff Nov 27, 2023

teowa Nov 29, 2023 •

edited

Loading

teowa Dec 1, 2023

Yvand commented Nov 27, 2023

teowa commented Dec 1, 2023

katbyte left a comment

MoussaBangre commented Jan 25, 2024

github-actions bot commented May 3, 2024

new resource azurerm_virtual_machine_run_command #23377

new resource azurerm_virtual_machine_run_command #23377

Conversation

teowa commented Sep 25, 2023

katbyte left a comment

Choose a reason for hiding this comment

teowa commented Oct 19, 2023 • edited Loading

katbyte commented Nov 7, 2023

tombuildsstuff left a comment

Choose a reason for hiding this comment

tombuildsstuff Nov 27, 2023

Choose a reason for hiding this comment

teowa Nov 29, 2023

Choose a reason for hiding this comment

gburkecw Apr 2, 2024

Choose a reason for hiding this comment

tombuildsstuff Nov 27, 2023

Choose a reason for hiding this comment

teowa Nov 29, 2023 • edited Loading

Choose a reason for hiding this comment

tombuildsstuff Nov 27, 2023

Choose a reason for hiding this comment

teowa Nov 29, 2023 • edited Loading

Choose a reason for hiding this comment

teowa Dec 1, 2023

Choose a reason for hiding this comment

Yvand commented Nov 27, 2023

teowa commented Dec 1, 2023

katbyte left a comment

Choose a reason for hiding this comment

MoussaBangre commented Jan 25, 2024

github-actions bot commented May 3, 2024

new resource `azurerm_virtual_machine_run_command` #23377

new resource `azurerm_virtual_machine_run_command` #23377

teowa commented Oct 19, 2023 •

edited

Loading

teowa Nov 29, 2023 •

edited

Loading

teowa Nov 29, 2023 •

edited

Loading