Управление секретами в Контейнерах приложений Azure

Статья
05/24/2023

Контейнеры приложений Azure позволяют приложению безопасно хранить конфиденциальные значения конфигурации. После определения секретов на уровне приложения защищенные значения доступны для редакций в приложениях контейнеров. Кроме того, можно ссылаться на защищенные значения внутри правил масштабирования. Сведения об использовании секретов с Dapr см. в статье об интеграции Dapr.

Секреты ограничены приложением за пределами какой-либо конкретной редакции приложения.
Добавление, удаление или изменение секретов не создает новые редакции.
Каждая редакция приложения может ссылаться на один или несколько секретов.
Несколько редакций могут ссылаться на одни и те же секреты.

Обновленный или удаленный секрет не влияет на существующие редакции в приложении. При обновлении или удалении секрета можно ответить на изменения одним из двух способов:

Развертывание новой редакции.
Перезапуск существующей редакции.

Перед удалением секрета разверните новую редакцию, которая больше не ссылается на старый секрет. Затем деактивируйте все редакции, ссылающиеся на секрет.

Определение секретов

Секреты определяются как набор пар name/value. Значение каждого секрета указывается непосредственно или в качестве ссылки на секрет, хранящийся в Azure Key Vault.

Сохранение значения секрета в приложениях-контейнерах

При определении секретов на портале или с помощью различных параметров командной строки.

Перейдите в приложение-контейнер в портал Azure.
В разделе Параметры выберите "Секреты".
Выберите Добавить.
В области "Добавление секрета" введите следующие сведения:
- Имя: имя секрета.
- Тип: выбор секрета приложений контейнеров.
- Значение: значение секрета.
Выберите Добавить.

Секреты определяются на уровне приложения в разделе resources.properties.configuration.secrets.

"resources": [
{
    ...
    "properties": {
        "configuration": {
            "secrets": [
            {
                "name": "queue-connection-string",
                "value": "<MY-CONNECTION-STRING-VALUE>"
            }],
        }
    }
}

Здесь строка подключения к учетной записи Хранилища очередей объявляется в массиве secrets. В этом примере вы замените <MY-CONNECTION-STRING-VALUE> значением строка подключения.

При создании приложения-контейнера секреты определяются с помощью --secrets параметра.

Параметр принимает разделенный пробелом набор пар name/value.
Каждая пара разделена знаком равенства (=).

az containerapp create \
  --resource-group "my-resource-group" \
  --name queuereader \
  --environment "my-environment-name" \
  --image demos/queuereader:v1 \
  --secrets "queue-connection-string=<CONNECTION_STRING>"

Здесь строка подключения к учетной записи Хранилища очередей объявляется в параметре --secrets. Замените <CONNECTION_STRING> значением строка подключения.

При создании приложения-контейнера секреты определяются как один или несколько объектов Secret, передаваемых через ConfigurationSecrets параметр.

$EnvId = (Get-AzContainerAppManagedEnv -ResourceGroupName my-resource-group -EnvName my-environment-name).Id
$TemplateObj = New-AzContainerAppTemplateObject -Name queuereader -Image demos/queuereader:v1
$SecretObj = New-AzContainerAppSecretObject -Name queue-connection-string -Value $QueueConnectionString

$ContainerAppArgs = @{
    Name = 'my-resource-group'
    Location = '<location>'
    ResourceGroupName = 'my-resource-group'
    ManagedEnvironmentId = $EnvId
    TemplateContainer = $TemplateObj
    ConfigurationSecret = $SecretObj
}

New-AzContainerApp @ContainerAppArgs

Здесь объявляется строка подключения учетной записи хранения очереди. Значение queue-connection-string, полученное из переменной среды с именем $QueueConnectionString.

Справочный секрет из Key Vault

При определении секрета создается ссылка на секрет, хранящийся в Azure Key Vault. Контейнерные приложения автоматически извлекают значение секрета из Key Vault и делают его доступным в качестве секрета в приложении контейнера.

Чтобы ссылаться на секрет из Key Vault, необходимо сначала включить управляемое удостоверение в приложении контейнера и предоставить удостоверению доступ к секретам Key Vault.

Сведения о включении управляемого удостоверения в приложении-контейнере см. в разделе "Управляемые удостоверения".

Чтобы предоставить доступ к секретам Key Vault, создайте политику доступа в Key Vault для созданного управляемого удостоверения. Включите в этой политике разрешения "Get" на получение секретов.

Перейдите в приложение-контейнер в портал Azure.
В разделе Параметры выберите "Удостоверение".
На вкладке "Назначаемая системой" нажмите кнопку "Вкл.".
Нажмите кнопку "Сохранить", чтобы включить управляемое удостоверение, назначаемое системой.
В разделе Параметры выберите "Секреты".
Выберите Добавить.
В области "Добавление секрета" введите следующие сведения:
- Имя: имя секрета.
- Тип: ссылка на Key Vault.
- URL-адрес секрета Key Vault: универсальный код ресурса (URI) секрета в Key Vault.
- Удостоверение: удостоверение, используемое для получения секрета из Key Vault.
Выберите Добавить.

Секреты определяются на уровне приложения в разделе resources.properties.configuration.secrets.

"resources": [
{
    ...
    "properties": {
        "configuration": {
            "secrets": [
            {
                "name": "queue-connection-string",
                "keyVaultUrl": "<KEY-VAULT-SECRET-URI>",
                "identity": "system"
            }],
        }
    }
}

Здесь строка подключения к учетной записи Хранилища очередей объявляется в массиве secrets. Его значение автоматически извлекается из Key Vault с помощью указанного удостоверения. Чтобы использовать управляемое удостоверение пользователя, замените system его идентификатором ресурса.

Замените <KEY-VAULT-SECRET-URI> URI секрета в Key Vault.

При создании приложения-контейнера секреты определяются с помощью --secrets параметра.

Параметр принимает разделенный пробелом набор пар name/value.
Каждая пара разделена знаком равенства (=).
Чтобы указать ссылку на Key Vault, используйте формат <SECRET_NAME>=keyvaultref:<KEY_VAULT_SECRET_URI>,identityref:<MANAGED_IDENTITY_ID>. Например, queue-connection-string=keyvaultref:https://mykeyvault.vault.azure.net/secrets/queuereader,identityref:/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-identity.

az containerapp create \
  --resource-group "my-resource-group" \
  --name queuereader \
  --environment "my-environment-name" \
  --image demos/queuereader:v1 \
  --user-assigned "<USER_ASSIGNED_IDENTITY_ID>" \
  --secrets "queue-connection-string=keyvaultref:<KEY_VAULT_SECRET_URI>,identityref:<USER_ASSIGNED_IDENTITY_ID>"

Здесь строка подключения к учетной записи Хранилища очередей объявляется в параметре --secrets. Замените <KEY_VAULT_SECRET_URI> URI секрета в Key Vault. Замените <USER_ASSIGNED_IDENTITY_ID> идентификатором ресурса назначаемого пользователем удостоверения. Для назначаемого системой удостоверения используйте system вместо идентификатора ресурса.

Примечание.

Удостоверение, назначаемое пользователем, должно иметь доступ к секрету в Key Vault. Назначенное системой удостоверение нельзя использовать с командой создания, так как она недоступна до создания приложения контейнера.

Примечание.

Если вы используете UDR с Брандмауэр Azure, необходимо добавить AzureKeyVault тег службы и полное доменное имя login.microsoft.com в список разрешений для брандмауэра. Ознакомьтесь с настройкой UDR с помощью Брандмауэр Azure, чтобы решить, какие дополнительные теги службы вам нужны.

Универсальный код ресурса (URI) секрета Key Vault и смена секретов

URI секрета Key Vault должен находиться в одном из следующих форматов:

https://myvault.vault.azure.net/secrets/mysecret/ec96f02080254f109c51a1f14cdb1931: ссылка на определенную версию секрета.
https://myvault.vault.azure.net/secrets/mysecret: ссылка на последнюю версию секрета.

Если версия не указана в URI, приложение использует последнюю версию, которая существует в хранилище ключей. Когда новые версии становятся доступными, приложение автоматически извлекает последнюю версию в течение 30 минут. Все активные редакции, ссылающиеся на секрет в переменной среды, автоматически перезапускается для получения нового значения.

Для полного управления версией секрета укажите версию в URI.

Ссылка на секреты в переменных среды

После объявления секретов на уровне приложения, как описано в разделе определения секретов , вы можете ссылаться на них в переменных среды при создании новой редакции в приложении контейнера. Если переменная среды ссылается на секрет, его значение заполняется значением, определенным в секрете.

Пример

В следующем примере показано приложение, которое объявляет строка подключения на уровне приложения. Это подключение ссылается в переменной среды контейнера и в правиле масштабирования.

После определения секрета в приложении-контейнере вы можете ссылаться на него в переменной среды при создании новой редакции.

Перейдите в приложение-контейнер в портал Azure.
Откройте страницу управления редакцией .
Выберите "Создать новую версию".
На странице "Создание и развертывание новой редакции" выберите контейнер.
В разделе переменных среды нажмите кнопку "Добавить".
Введите следующие данные:
- Имя: имя переменной среды.
- Источник: выбор ссылки на секрет.
- Значение. Выберите секрет, на который вы хотите ссылаться.
Выберите Сохранить.
Нажмите кнопку "Создать", чтобы создать новую редакцию.

В этом примере строка подключения приложения объявляется как queue-connection-string и становится доступной в других разделах конфигурации.

{
    "$schema": "https://schema.management.azure.com/schemas/2019-08-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "location": {
            "type": "String"
        },
        "environment_id": {
            "type": "String"
        },
        "queue-connection-string": {
            "type": "String"
        }
    },
    "variables": {},
    "resources": [
    {
        "name": "queuereader",
        "type": "Microsoft.App/containerApps",
        "apiVersion": "2022-03-01",
        "kind": "containerapp",
        "location": "[parameters('location')]",
        "properties": {
            "managedEnvironmentId": "[parameters('environment_id')]",
            "configuration": {
                "activeRevisionsMode": "single",
                "secrets": [
                {
                    "name": "queue-connection-string",
                    "value": "[parameters('queue-connection-string')]"
                }]
            },
            "template": {
                "containers": [
                    {
                        "image": "myregistry/myQueueApp:v1",
                        "name": "myQueueApp",
                        "env": [
                            {
                                "name": "QueueName",
                                "value": "myqueue"
                            },
                            {
                                "name": "ConnectionString",
                                "secretRef": "queue-connection-string"
                            }
                        ]
                    }
                ],
                "scale": {
                    "minReplicas": 0,
                    "maxReplicas": 10,
                    "rules": [
                        {
                            "name": "myqueuerule",
                            "azureQueue": {
                                "queueName": "demoqueue",
                                "queueLength": 100,
                                "auth": [
                                    {
                                        "secretRef": "queue-connection-string",
                                        "triggerParameter": "connection"
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        }
    }]
}

Здесь переменная среды с именем connection-string получает значение из секрета уровня приложения queue-connection-string. Кроме того, в конфигурации проверки подлинности правила масштабирования очереди Azure служба хранилища используется queue-connection-string секрет для определения его подключения.

Чтобы избежать фиксации секретных значений в системе управления версиями с помощью шаблона ARM, передайте значения секретов в качестве параметров шаблона ARM.

В этом примере вы создадите приложение-контейнер с помощью Azure CLI с секретом, на который ссылается переменная среды. Чтобы ссылаться на секрет в переменной среды в Azure CLI, задайте для нее значение secretref:, а затем имя секрета.

az containerapp create \
  --resource-group "my-resource-group" \
  --name myQueueApp \
  --environment "my-environment-name" \
  --image demos/myQueueApp:v1 \
  --secrets "queue-connection-string=$CONNECTIONSTRING" \
  --env-vars "QueueName=myqueue" "ConnectionString=secretref:queue-connection-string"

Здесь переменная среды с именем connection-string получает значение из секрета уровня приложения queue-connection-string.

В этом примере вы создадите контейнер с помощью Azure PowerShell с секретом, на который ссылается переменная среды. Чтобы ссылаться на секрет в переменной среды в PowerShell, задайте для нее значение secretref:, за которым следует имя секрета.

$EnvId = (Get-AzContainerAppManagedEnv -ResourceGroupName my-resource-group -EnvName my-environment-name).Id

$SecretObj = New-AzContainerAppSecretObject -Name queue-connection-string -Value $QueueConnectionString
$EnvVarObjQueue = New-AzContainerAppEnvironmentVarObject -Name QueueName -Value myqueue
$EnvVarObjConn = New-AzContainerAppEnvironmentVarObject -Name ConnectionString -SecretRef queue-connection-string -Value secretref
$TemplateObj = New-AzContainerAppTemplateObject -Name myQueueApp -Image demos/myQueueApp:v1 -Env $EnvVarObjQueue, $EnvVarObjConn

$ContainerAppArgs = @{
    Name = 'myQueueApp'
    Location = '<location>'
    ResourceGroupName = 'my-resource-group'
    ManagedEnvironmentId = $EnvId
    TemplateContainer = $TemplateObj
    ConfigurationSecret = $SecretObj
}

New-AzContainerApp @ContainerAppArgs

Здесь переменная среды с именем ConnectionString получает значение из секрета уровня приложения $QueueConnectionString.

Подключение секретов в томе

После объявления секретов на уровне приложения, как описано в разделе определения секретов , вы можете ссылаться на них в подключениях томов при создании новой редакции в приложении контейнера. При подключении секретов в томе каждый секрет подключается в виде файла в томе. Имя файла — это имя секрета, а содержимое файла — значение секрета. Вы можете загрузить все секреты в подключение тома или загрузить определенные секреты.

Пример

После определения секрета в приложении-контейнере вы можете ссылаться на него в подключении томов при создании новой редакции.

Перейдите в приложение-контейнер в портал Azure.
Откройте страницу управления редакцией .
Выберите "Создать новую версию".
На странице создания и развертывания новой редакции.
Выберите контейнер и нажмите кнопку "Изменить".
В разделе "Подключения томов" разверните раздел "Секреты".
Выберите "Создать новый том".
Введите следующие данные:
- Имя: mysecrets
- Подключение всех секретов: включено
Примечание.

Если вы хотите загрузить определенные секреты, отключите все секреты и выберите секреты, которые вы хотите загрузить.
Выберите Добавить.
В разделе "Имя тома" выберите mysecrets.
В разделе "Путь подключения" введите /mnt/secret.
Выберите Сохранить.
Выберите "Создать" , чтобы создать новую редакцию с подключением тома.

В этом примере два секрета объявляются на уровне приложения. Эти секреты подключены в томе с именем mysecrets типа Secret. Том подключается по пути /mnt/secrets. Затем приложение может ссылаться на секреты в подключении тома.

{
    "$schema": "https://schema.management.azure.com/schemas/2019-08-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "location": {
            "type": "String"
        },
        "environment_id": {
            "type": "String"
        },
        "queue-connection-string": {
            "type": "Securestring"
        },
        "api-key": {
            "type": "Securestring"
        }
    },
    "variables": {},
    "resources": [
    {
        "name": "queuereader",
        "type": "Microsoft.App/containerApps",
        "apiVersion": "2022-11-01-preview",
        "kind": "containerapp",
        "location": "[parameters('location')]",
        "properties": {
            "managedEnvironmentId": "[parameters('environment_id')]",
            "configuration": {
                "activeRevisionsMode": "single",
                "secrets": [
                    {
                        "name": "queue-connection-string",
                        "value": "[parameters('queue-connection-string')]"
                    },
                    {
                        "name": "api-key",
                        "value": "[parameters('api-key')]"
                    }
                ]
            },
            "template": {
                "containers": [
                    {
                        "image": "myregistry/myQueueApp:v1",
                        "name": "myQueueApp",
                        "volumeMounts": [
                            {
                                "name": "mysecrets",
                                "mountPath": "/mnt/secrets"
                            }
                        ]
                    }
                ],
                "volumes": [
                    {
                        "name": "mysecrets",
                        "storageType": "Secret"
                    }
                ]
            }
        }
    }]
}

Чтобы загрузить определенные секреты и указать пути в подключенном томе, определите секреты в secrets массиве объекта тома. В следующем примере показано, как загрузить только queue-connection-string секрет в подключении тома mysecrets с именем connection-string.txtфайла.

{
    "properties": {
        ...
        "configuration": {
            ...
            "secrets": [
                {
                    "name": "queue-connection-string",
                    "value": "[parameters('queue-connection-string')]"
                },
                {
                    "name": "api-key",
                    "value": "[parameters('api-key')]"
                }
            ]
        },
        "template": {
            "containers": [
                {
                    "image": "myregistry/myQueueApp:v1",
                    "name": "myQueueApp",
                    "volumeMounts": [
                        {
                            "name": "mysecrets",
                            "mountPath": "/mnt/secrets"
                        }
                    ]
                }
            ],
            "volumes": [
                {
                    "name": "mysecrets",
                    "storageType": "Secret",
                    "secrets": [
                        {
                            "secretRef": "queue-connection-string",
                            "path": "connection-string.txt"
                        }
                    ]
                }
            ]
        }
        ...
    }
    ...
}

В приложении вы можете прочитать секрет из файла, расположенного по адресу /mnt/secrets/connection-string.txt.

В этом примере два секрета объявляются на уровне приложения. Эти секреты подключены в томе с именем mysecrets типа Secret. Том подключается по пути /mnt/secrets. Затем приложение может считывать секреты в виде файлов в подключении тома.

az containerapp create \
  --resource-group "my-resource-group" \
  --name myQueueApp \
  --environment "my-environment-name" \
  --image demos/myQueueApp:v1 \
  --secrets "queue-connection-string=$CONNECTIONSTRING" "api-key=$API_KEY" \
  --secret-volume-mount "/mnt/secrets"

Чтобы загрузить определенные секреты и указать пути в подключенном томе, определите приложение с помощью YAML.

Следующие шаги

Контейнеры

Управление секретами в Контейнерах приложений Azure

Определение секретов

Сохранение значения секрета в приложениях-контейнерах

Справочный секрет из Key Vault

Универсальный код ресурса (URI) секрета Key Vault и смена секретов

Ссылка на секреты в переменных среды

Пример

Подключение секретов в томе

Пример

Следующие шаги

Дополнительные ресурсы