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_container_group - Supports CMK with user assigned identity #23332

Merged
merged 2 commits into from
Sep 21, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions internal/services/containers/container_group_resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,12 @@ func resourceContainerGroup() *pluginsdk.Resource {
ForceNew: true,
ValidateFunc: keyVaultValidate.NestedItemId,
},

"key_vault_user_identity_id": {
Copy link
Member

Choose a reason for hiding this comment

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

Currently the identity properties for CMK are inconsistent across the provider, some are called identity_id, primary_user_assigned_identity_id or user_assigned_identity_id. We might want to consider standardising these for the next major release and having a commonschema for them like we do for identities.

All this to say, I think for the time being this might benefit from being called key_vault_user_assigned_identity_id since it's clear at first glance what type of ID it is and is also closer to what we currently have in the provider.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Renamed.

Type: pluginsdk.TypeString,
Optional: true,
ValidateFunc: commonids.ValidateUserAssignedIdentityID,
},
},
}
}
Expand Down Expand Up @@ -777,6 +783,10 @@ func resourceContainerGroupCreate(d *pluginsdk.ResourceData, meta interface{}) e
KeyName: keyId.Name,
KeyVersion: keyId.Version,
}

if keyVaultUAI := d.Get("key_vault_user_identity_id").(string); keyVaultUAI != "" {
containerGroup.Properties.EncryptionProperties.Identity = &keyVaultUAI
}
}

// Avoid parallel provisioning if "subnet_ids" are given.
Expand Down Expand Up @@ -942,6 +952,12 @@ func resourceContainerGroupRead(d *pluginsdk.ResourceData, meta interface{}) err
return err
}
d.Set("key_vault_key_id", keyId.ID())

var uai string
if kvProps.Identity != nil {
uai = *kvProps.Identity
}
d.Set("key_vault_user_identity_id", uai)
Copy link
Member

Choose a reason for hiding this comment

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

This can become

Suggested change
d.Set("key_vault_user_identity_id", uai)
d.Set("key_vault_user_identity_id", pointer.From(kvProps.Identity))

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure, I'll change it.

}
}

Expand Down
121 changes: 121 additions & 0 deletions internal/services/containers/container_group_resource_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,21 @@ func TestAccContainerGroup_encryption(t *testing.T) {
})
}

func TestAccContainerGroup_encryptionWithUserAssignedIdentity(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_container_group", "test")
r := ContainerGroupResource{}

data.ResourceTest(t, r, []acceptance.TestStep{
{
Config: r.encryptionWithUserAssignedIdentity(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep(),
})
}

func TestAccContainerGroup_securityContext(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_container_group", "test")
r := ContainerGroupResource{}
Expand Down Expand Up @@ -2489,6 +2504,112 @@ resource "azurerm_container_group" "test" {
`, data.RandomInteger, data.Locations.Primary, data.RandomInteger)
}

func (ContainerGroupResource) encryptionWithUserAssignedIdentity(data acceptance.TestData) string {
return fmt.Sprintf(`
provider "azurerm" {
features {}
}

resource "azurerm_resource_group" "test" {
name = "acctestRG-%[1]d"
location = "%[2]s"
}

data "azurerm_client_config" "current" {}

resource "azurerm_key_vault" "test" {
name = "acc-%[1]d"
location = azurerm_resource_group.test.location
resource_group_name = azurerm_resource_group.test.name
tenant_id = data.azurerm_client_config.current.tenant_id
sku_name = "standard"
}

resource "azurerm_key_vault_access_policy" "terraform" {
key_vault_id = azurerm_key_vault.test.id
key_permissions = [
"Create",
"Delete",
"Get",
"List",
"Purge",
"Update",
"GetRotationPolicy",
]

secret_permissions = [
"Get",
"Delete",
"Set",
]
tenant_id = data.azurerm_client_config.current.tenant_id
object_id = data.azurerm_client_config.current.object_id
}

resource "azurerm_key_vault_key" "test" {
name = "key-%[1]d"
key_vault_id = azurerm_key_vault.test.id
key_type = "RSA"
key_size = 2048

key_opts = [
"decrypt",
"encrypt",
"sign",
"unwrapKey",
"verify",
"wrapKey",
]
depends_on = [azurerm_key_vault_access_policy.terraform]
}

resource "azurerm_user_assigned_identity" "test" {
location = azurerm_resource_group.test.location
resource_group_name = azurerm_resource_group.test.name
name = "uai-%[1]d"
}

resource "azurerm_key_vault_access_policy" "test" {
key_vault_id = azurerm_key_vault.test.id
key_permissions = [
"Get",
"UnwrapKey",
"WrapKey",
"GetRotationPolicy",
]
tenant_id = azurerm_user_assigned_identity.test.tenant_id
object_id = azurerm_user_assigned_identity.test.principal_id
depends_on = [azurerm_key_vault_access_policy.terraform]
}

resource "azurerm_container_group" "test" {
name = "acctestcontainergroup-%[1]d"
location = azurerm_resource_group.test.location
resource_group_name = azurerm_resource_group.test.name
ip_address_type = "Public"
os_type = "Linux"

container {
name = "hw"
image = "ubuntu:20.04"
cpu = "0.5"
memory = "0.5"
ports {
port = 80
protocol = "TCP"
}
}
key_vault_key_id = azurerm_key_vault_key.test.id
key_vault_user_identity_id = azurerm_user_assigned_identity.test.id
identity {
type = "UserAssigned"
identity_ids = [azurerm_user_assigned_identity.test.id]
}
depends_on = [azurerm_key_vault_access_policy.test]
}
`, data.RandomInteger, data.Locations.Primary, data.RandomInteger)
}

func (ContainerGroupResource) securityContextPriviledged(data acceptance.TestData, v bool) string {
return fmt.Sprintf(`
provider "azurerm" {
Expand Down
2 changes: 2 additions & 0 deletions website/docs/r/container_group.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ The following arguments are supported:

* `key_vault_key_id` - (Optional) The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.

* `key_vault_user_identity_id` - (Optional) The user assigned identity that has access to the Key Vault Key. If not specified, the RP principal named "Azure Container Instance Service" will be used instead. Make sure the identity has the proper `key_permissions` set, at least with `Get`, `UnwrapKey`, `WrapKey` and `GetRotationPolicy`.
Copy link
Member

Choose a reason for hiding this comment

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

The ordering of the sentences here is a little confusing, are the key_permissions that are needed for the RP Principal or for key_vault_user_identity_id? Or both?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It should be both identities.


* `subnet_ids` - (Optional) The subnet resource IDs for a container group. Changing this forces a new resource to be created.

* `image_registry_credential` - (Optional) An `image_registry_credential` block as documented below. Changing this forces a new resource to be created.
Expand Down