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

container_app_job: support secrets from Key Vault #25969

Merged

Conversation

Botje
Copy link
Contributor

@Botje Botje commented May 15, 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 referencing Key Vault secrets from Container App Jobs and lifts the restriction on removing secrets.
This code is ported from the Container Apps 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)
Testing evidence
TF_ACC=1 go test -v ./internal/services/containerapps -run=TestAccContainerAppJob_withKeyVault -timeout 60m -ldflags="-X=github.com/hashicorp/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccContainerAppJob_withKeyVaultSecret
=== PAUSE TestAccContainerAppJob_withKeyVaultSecret
=== RUN   TestAccContainerAppJob_withKeyVaultSecretVersioningUpdate
=== PAUSE TestAccContainerAppJob_withKeyVaultSecretVersioningUpdate
=== RUN   TestAccContainerAppJob_withKeyVaultSecretIdentityUpdate
=== PAUSE TestAccContainerAppJob_withKeyVaultSecretIdentityUpdate
=== CONT  TestAccContainerAppJob_withKeyVaultSecret
=== CONT  TestAccContainerAppJob_withKeyVaultSecretIdentityUpdate
=== CONT  TestAccContainerAppJob_withKeyVaultSecretVersioningUpdate
--- PASS: TestAccContainerAppJob_withKeyVaultSecret (894.40s)
--- PASS: TestAccContainerAppJob_withKeyVaultSecretVersioningUpdate (974.74s)
--- PASS: TestAccContainerAppJob_withKeyVaultSecretIdentityUpdate (1019.78s)
PASS
ok  	github.com/hashicorp/terraform-provider-azurerm/internal/services/containerapps	1022.386s

Change Log

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

  • container_app_job - support secrets from Key Vault [GH-0000]
  • container_app_job - allow removing secrets [GH-0000]

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 #25934
Fixes #25994

Note

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

Copy link
Member

@jackofallops jackofallops left a comment

Choose a reason for hiding this comment

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

Hi @Botje - We're having trouble running the tests for this PR due to some dependency changes/issues with main that have crept in somewhere. Are you able to update your fork's main and rebase to allow us to run the tests?

Scratch that - sorry - appears to have been a problem with our CI system picking up changes... will loop back asap.

@Botje
Copy link
Contributor Author

Botje commented May 31, 2024

Despite subscribing to the linked issue, I did not get a notification. I will update the tests anyway, as promised.

@Botje Botje force-pushed the f/25934/ca-job-support-kv-secrets branch from 87f7153 to e4da14d Compare May 31, 2024 09:30
@Botje
Copy link
Contributor Author

Botje commented May 31, 2024

Rebased on current main branch and converted the tests to use secret and registry.

@Botje Botje force-pushed the f/25934/ca-job-support-kv-secrets branch from e4da14d to 15d989d Compare May 31, 2024 09:32
Copy link
Member

@jackofallops jackofallops left a comment

Choose a reason for hiding this comment

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

Hi @Botje - Thanks for the rebase and update. Just one minor docs change to look at and then I think this will be good to go, pending testing.

website/docs/r/container_app_job.html.markdown Outdated Show resolved Hide resolved
Copy link
Member

@jackofallops jackofallops 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 for the updates. This LGTM, I'll get the tests run now.

@jackofallops
Copy link
Member

Tests look fine (failures are unrelated to change)

image

@jackofallops jackofallops merged commit 4210ad6 into hashicorp:main Jun 3, 2024
33 checks passed
@github-actions github-actions bot added this to the v3.107.0 milestone Jun 3, 2024
jackofallops added a commit that referenced this pull request Jun 3, 2024
@Botje Botje deleted the f/25934/ca-job-support-kv-secrets branch June 3, 2024 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment