Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

azurerm_disk_encryption_set: Support for the managed_hsm_key_id property #26201

Merged
merged 9 commits into from
Jun 28, 2024

Conversation

Botje
Copy link
Contributor

@Botje Botje commented Jun 3, 2024

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 "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review

Description

This PR adds support for HSMs to the disk encryption set resource.

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)

I did not run any tests because deploying Managed HSMs exceeds the budget of my personal playground subscription.

Change Log

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

  • disk_encryption_set - support for managed HSMs [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 #21470

Note

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

@Botje
Copy link
Contributor Author

Botje commented Jun 3, 2024

"service/disk" seems an appropriate label, too.

Copy link
Collaborator

@katbyte katbyte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the pr @Botje - looks like we have a test failure:

------- Stdout: -------
=== RUN   TestAccDiskEncryptionSet_disablePurgeProtection
=== PAUSE TestAccDiskEncryptionSet_disablePurgeProtection
=== CONT  TestAccDiskEncryptionSet_disablePurgeProtection
    testcase.go:113: Step 1/2 error: Error running apply: exit status 1
        
        Error: validating Key Vault "acctestkv-jknzr" (Resource Group "acctestRG-240618213622132222") for Disk Encryption Set: Purge Protection must be enabled
        
          with azurerm_disk_encryption_set.test,
          on terraform_plugin_test.tf line 105, in resource "azurerm_disk_encryption_set" "test":
         105: resource "azurerm_disk_encryption_set" "test" {
        
--- FAIL: TestAccDiskEncryptionSet_disablePurgeProtection (328.83s)
FAIL

Copy link
Collaborator

@katbyte katbyte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the pr @Botje - looks like we have a test failure:

------- Stdout: -------
=== RUN   TestAccDiskEncryptionSet_disablePurgeProtection
=== PAUSE TestAccDiskEncryptionSet_disablePurgeProtection
=== CONT  TestAccDiskEncryptionSet_disablePurgeProtection
    testcase.go:113: Step 1/2 error: Error running apply: exit status 1
        
        Error: validating Key Vault "acctestkv-jknzr" (Resource Group "acctestRG-240618213622132222") for Disk Encryption Set: Purge Protection must be enabled
        
          with azurerm_disk_encryption_set.test,
          on terraform_plugin_test.tf line 105, in resource "azurerm_disk_encryption_set" "test":
         105: resource "azurerm_disk_encryption_set" "test" {
        
--- FAIL: TestAccDiskEncryptionSet_disablePurgeProtection (328.83s)
FAIL

@Botje
Copy link
Contributor Author

Botje commented Jun 28, 2024

Hi @katbyte,

--- FAIL: TestAccDiskEncryptionSet_disablePurgeProtection (328.83s)

This was an asymmetry I noticed in the code: the creation path does not test for purge protection but the update path does. I assumed this was an oversight and implemented the same check for both create and update.
Looking at the git blame output for that specific test, I notice that that actually removed the purge protection check on creation.
I think the proper course of action is then also to remove the purge protection check alltogether.

Copy link
Collaborator

@katbyte katbyte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Botje that makes sense to me and all tests now pass. LGTM :basecamp:

@katbyte katbyte merged commit aa140a6 into hashicorp:main Jun 28, 2024
35 checks passed
@katbyte katbyte changed the title disk_encryption_set: Support managed HSMs azurerm_disk_encryption_set: Support for the managed_hsm_key_id property Jun 28, 2024
@github-actions github-actions bot added this to the v3.111.0 milestone Jun 28, 2024
katbyte added a commit that referenced this pull request Jun 28, 2024
dduportal pushed a commit to jenkins-infra/azure that referenced this pull request Jul 8, 2024
<Actions>
<action
id="f410411e63aff4bb73a81c2aec1d373cf8a903e63b30dee2006b0030d8a94cc8">
        <h3>Bump Terraform `azurerm` provider version</h3>
<details
id="1d9343c012f5434ac9fe8a98135bae3667b399259be16d9b14302ea3bd424a24">
            <summary>Update Terraform lock file</summary>
<p>changes detected:&#xA;&#x9;&#34;hashicorp/azurerm&#34; updated from
&#34;3.110.0&#34; to &#34;3.111.0&#34; in file
&#34;.terraform.lock.hcl&#34;</p>
            <details>
                <summary>3.111.0</summary>
<pre>Changelog retrieved
from:&#xA;&#x9;https://github.com/hashicorp/terraform-provider-azurerm/releases/tag/v3.111.0&#xA;FEATURES:&#xA;&#xA;*
**New Resource:** `azurerm_restore_point_collection`
([#26518](https://github.com/hashicorp/terraform-provider-azurerm/issues/26518))&#xA;&#xA;ENHANCEMENTS:&#xA;&#xA;*
dependencies: updating to `v0.20240701.1082110` of
`github.com/hashicorp/go-azure-sdk`
([#26502](https://github.com/hashicorp/terraform-provider-azurerm/issues/26502))&#xA;*
`azurerm_disk_encryption_set` - support for the `managed_hsm_key_id`
property
([#26201](https://github.com/hashicorp/terraform-provider-azurerm/issues/26201))&#xA;*
`azurerm_firewall_policy` - remove Computed from the `sku` property and
add a default of `Standard` in 4.0
([#26499](https://github.com/hashicorp/terraform-provider-azurerm/issues/26499))&#xA;*
`azurerm_kubernetes_cluster` - support updating
`default_node_pool.os_sku` between `Ubuntu` and `AzureLinux`
([#26262](https://github.com/hashicorp/terraform-provider-azurerm/issues/26262))&#xA;*
`azurerm_kubernetes_cluster_node_pool` - support updating `os_sku`
between `Ubuntu` and `AzureLinux`
([#26139](https://github.com/hashicorp/terraform-provider-azurerm/issues/26139))&#xA;*
`azurerm_service_plan` - support for new the Flex Consumption plan
([#26351](https://github.com/hashicorp/terraform-provider-azurerm/issues/26351))&#xA;&#xA;BUG
FIXES:&#xA;&#xA;* `azurerm_kubernetes_cluster` - prevent a panic
([#26478](https://github.com/hashicorp/terraform-provider-azurerm/issues/26478))&#xA;*
`azurerm_kubernetes_cluster` - prevent a diff in `upgrade_settings` when
the API returns an empty object
([#26541](https://github.com/hashicorp/terraform-provider-azurerm/issues/26541))&#xA;*
`azurerm_kubernetes_cluster_node_pool` - prevent a diff in
`upgrade_settings` when the API returns an empty object
([#26541](https://github.com/hashicorp/terraform-provider-azurerm/issues/26541))&#xA;*
`azurerm_virtual_network_gateway` - split create and update function to
fix lifecycle - ignore
([#26451](https://github.com/hashicorp/terraform-provider-azurerm/issues/26451))&#xA;*
`azurerm_virtual_network_gateway_connection` - split create and update
function to fix lifecycle - ignore
([#26431](https://github.com/hashicorp/terraform-provider-azurerm/issues/26431))&#xA;&#xA;&#xA;</pre>
            </details>
        </details>
<a
href="https://infra.ci.jenkins.io/job/updatecli/job/azure/job/main/306/">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) <60776566+jenkins-infra-bot@users.noreply.github.com>
Copy link

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 github-actions bot locked as resolved and limited conversation to collaborators Jul 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

disk_encryption_set doesn't support referencing a key in a managed HSM key vault in the key_vault_key_id
3 participants