Skip to content

Commit 3cfb427

Browse files
committed
Update Batch account cert migration guide
1 parent bff6fb6 commit 3cfb427

File tree

3 files changed

+30
-12
lines changed

3 files changed

+30
-12
lines changed

articles/batch/automatic-certificate-rotation.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ title: Enable automatic certificate rotation in a Batch pool
33
description: You can create a Batch pool with a managed identity and a certificate that will automatically be renewed.
44
ms.topic: conceptual
55
ms.custom: devx-track-linux
6-
ms.date: 05/24/2023
6+
ms.date: 12/05/2023
77
---
88
# Enable automatic certificate rotation in a Batch pool
99

1010
You can create a Batch pool with a certificate that will automatically be renewed. To do so, your pool must be created with a [user-assigned managed identity](managed-identity-pools.md) that will have access to the certificate in [Azure Key Vault](../key-vault/general/overview.md).
1111

1212
## Create a user-assigned identity
1313

14-
First, [create your user-assigned managed identity](../active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-portal.md#create-a-user-assigned-managed-identity) in the same tenant as your Batch account. This managed identity does not need to be in the same resource group or even in the same subscription.
14+
First, [create your user-assigned managed identity](../active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-portal.md#create-a-user-assigned-managed-identity) in the same tenant as your Batch account. This managed identity doesn't need to be in the same resource group or even in the same subscription.
1515

1616
Be sure to note the **Client ID** of the user-assigned managed identity. You'll need this value later.
1717

@@ -37,6 +37,9 @@ In your key vault, assign a Key Vault access policy that allows your user-assign
3737

3838
Create a Batch pool with your managed identity by using the [Batch .NET management library](/dotnet/api/overview/azure/batch#management-library). For more information, see [Configure managed identities in Batch pools](managed-identity-pools.md).
3939

40+
> [!TIP]
41+
> Existing pools cannot be updated with the Key Vault VM extension. You will need to recreate your pool.
42+
4043
The following example uses the Batch Management REST API to create a pool. Be sure to use your certificate's **Secret Identifier** for `observedCertificates` and your managed identity's **Client ID** for `msiClientId`, replacing the example data below.
4144

4245
REST API URI
@@ -84,10 +87,10 @@ Request Body
8487
"authenticationSettings": {
8588
"msiEndpoint": "http://169.254.169.254/metadata/identity",
8689
"msiClientId": "b9f6dd56-d2d6-4967-99d7-8062d56fd84c"
87-
}
90+
}
8891
},
89-
}
90-
]
92+
}
93+
]
9194
}
9295
},
9396
"scaleSettings": {

articles/batch/batch-certificate-migration-guide.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Migrate Batch account certificates to Azure Key Vault
33
description: Learn how to migrate Batch account certificates to Azure Key Vault and plan for feature end of support.
44
ms.service: batch
55
ms.topic: how-to
6-
ms.date: 03/08/2023
6+
ms.date: 12/05/2023
77
---
88

99
# Migrate Batch account certificates to Azure Key Vault
@@ -22,15 +22,15 @@ After the certificates feature in Azure Batch is retired on February 29, 2024, a
2222

2323
## Alternative: Use Azure Key Vault VM extension with pool user-assigned managed identity
2424

25-
Azure Key Vault is a fully managed Azure service that provides controlled access to store and manage secrets, certificates, tokens, and keys. Key Vault provides security at the transport layer by ensuring that any data flow from the key vault to the client application is encrypted. Azure Key Vault gives you a secure way to store essential access information and to set fine-grained access control. You can manage all secrets from one dashboard. Choose to store a key in either software-protected or hardware-protected hardware security modules (HSMs). You also can set Key Vault to auto-renew certificates.
25+
Azure Key Vault is a fully managed Azure service that provides controlled access to store and manage secrets, certificates, tokens, and keys. Key Vault provides security at the transport layer by ensuring that any data flow from the key vault to the client application is encrypted. Azure Key Vault gives you a secure way to store essential access information and to set fine-grained access control. You can manage all secrets from one dashboard. Choose to store a key in either software-protected or hardware-protected hardware security modules (HSMs). You also can set Key Vault to autorenew certificates.
2626

2727
For a complete guide on how to enable Azure Key Vault VM Extension with Pool User-assigned Managed Identity, see [Enable automatic certificate rotation in a Batch pool](automatic-certificate-rotation.md).
2828

2929
## FAQs
3030

3131
- Do `CloudServiceConfiguration` pools support Azure Key Vault VM extension and managed identity on pools?
3232

33-
No. `CloudServiceConfiguration` pools will be [retired](https://azure.microsoft.com/updates/azure-batch-cloudserviceconfiguration-pools-will-be-retired-on-29-february-2024/) on the same date as Azure Batch account certificate retirement on February 29, 2024. We recommend that you migrate to `VirtualMachineConfiguration` pools before that date where you'll be able to use these solutions.
33+
No. `CloudServiceConfiguration` pools will be [retired](https://azure.microsoft.com/updates/azure-batch-cloudserviceconfiguration-pools-will-be-retired-on-29-february-2024/) on the same date as Azure Batch account certificate retirement on February 29, 2024. We recommend that you migrate to `VirtualMachineConfiguration` pools before that date where you're able to use these solutions.
3434

3535
- Do user subscription pool allocation Batch accounts support Azure Key Vault?
3636

@@ -40,9 +40,21 @@ For a complete guide on how to enable Azure Key Vault VM Extension with Pool Use
4040

4141
Yes. See the documentation for [Windows](../virtual-machines/extensions/key-vault-windows.md) and [Linux](../virtual-machines/extensions/key-vault-linux.md).
4242

43+
- Can you update existing pools with a Key Vault VM extension?
44+
45+
No, these properties aren't updateable on the pool. You need to recreate pools.
46+
4347
- How do I get references to certificates on Linux Batch Pools since `$AZ_BATCH_CERTIFICATES_DIR` will be removed?
4448

45-
The Key Vault VM extension for Linux allows you to specify the `certificateStoreLocation`, which is an absolute path to where the certificate will be stored.
49+
The Key Vault VM extension for Linux allows you to specify the `certificateStoreLocation`, which is an absolute path to where the certificate are stored. The Key Vault VM extension will scope certificates installed at the specified location with only superuser (root) privileges. You need to make sure that your tasks run elevated to access these certificates by default, or copy the certificates to an accessible directly and/or adjust certificate files with proper file modes. You can run such commands as part of an elevated start task or job prep task.
50+
51+
- How do I install `.cer` files that don't contain private keys?
52+
53+
Key Vault doesn't consider these files to be privileged as they don't contain private key information. You can install `.cer` files using either of the following methods. Use Key Vault [secrets](../key-vault/secrets/about-secrets.md) with appropriate access privileges for the associated User-assigned Managed Identity and fetch the `.cer` file as part of your start task to install. Alternatively, store the `.cer` file as an Azure Storage Blob and reference as a Batch [resource file](resource-files.md) in your start task to install.
54+
55+
- How do I access Key Vault extension installed certificates for task-level nonadmin autouser pool identities?
56+
57+
Task-level autousers are created on-demand and can't be predefined for specifying into the `accounts` property in the Key Vault VM extension. You'll need a custom process that exports the required certificate into a commonly accessible store or ACLs appropriately for access by task-level autousers.
4658

4759
- Where can I find best practices for using Azure Key Vault?
4860

articles/batch/create-pool-extensions.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: Use extensions with Batch pools
3-
description: Extensions are small applications that facilitate post-provisioning configuration and setup on Batch compute nodes.
3+
description: Extensions are small applications that facilitate post-provisioning configuration and setup on Batch compute nodes.
44
ms.topic: how-to
55
ms.custom: devx-track-linux
6-
ms.date: 05/26/2023
6+
ms.date: 12/05/2023
77
---
88

99
# Use extensions with Batch pools
1010

11-
Extensions are small applications that facilitate post-provisioning configuration and setup on Batch compute nodes. You can select any of the extensions that are allowed by Azure Batch and have them installed on the compute nodes as they are provisioned. After that, the extension can perform its intended operation.
11+
Extensions are small applications that facilitate post-provisioning configuration and setup on Batch compute nodes. You can select any of the extensions that are allowed by Azure Batch and have them installed on the compute nodes as they're provisioned. After that, the extension can perform its intended operation.
1212

1313
You can check the live status of the extensions you use and retrieve the information they return in order to pursue any detection, correction, or diagnostics capabilities.
1414

@@ -18,6 +18,9 @@ You can check the live status of the extensions you use and retrieve the informa
1818
- The CustomScript extension type is reserved for the Azure Batch service and can't be overridden.
1919
- Some extensions may need pool-level Managed Identity accessible in the context of a compute node in order to function properly. Please see [configuring managed identities in Batch pools](managed-identity-pools.md) if applicable for the extension(s).
2020

21+
> [!TIP]
22+
> Extensions cannot be added to an existing pool. Pools must be recreated to add, remove, or update extensions.
23+
2124
## Supported extensions
2225

2326
The following extensions can currently be installed when creating a Batch pool:

0 commit comments

Comments
 (0)