Skip to content

Commit 427d56e

Browse files
authored
Merge pull request #166625 from cynthn/app-packages
Drafting application packages docs
2 parents e6069bc + 3830267 commit 427d56e

File tree

72 files changed

+1287
-624
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+1287
-624
lines changed

articles/batch/batch-custom-images.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ ms.date: 11/18/2020
77

88
# Use a managed image to create a custom image pool
99

10-
To create a custom image pool for your Batch pool's virtual machines (VMs), you can use a managed image to create a [Shared Image Gallery image](batch-sig-images.md). Using just a managed image is also supported, but only for API versions up to and including 2019-08-01.
10+
To create a custom image pool for your Batch pool's virtual machines (VMs), you can use a managed image to create an [Azure Compute Gallery image](batch-sig-images.md). Using just a managed image is also supported, but only for API versions up to and including 2019-08-01.
1111

1212
> [!IMPORTANT]
13-
> In most cases, you should create custom images using the Shared Image Gallery. By using the Shared Image Gallery, you can provision pools faster, scale larger quantities of VMs, and have improved reliability when provisioning VMs. To learn more, see [Use the Shared Image Gallery to create a custom pool](batch-sig-images.md).
13+
> In most cases, you should create custom images using the Azure Compute Gallery. By using the Azure Compute Gallery, you can provision pools faster, scale larger quantities of VMs, and have improved reliability when provisioning VMs. To learn more, see [Use the Azure Compute Gallery to create a custom pool](batch-sig-images.md).
1414
1515
This topic explains how to create a custom image pool using only a managed image.
1616

@@ -136,7 +136,7 @@ Also note the following considerations:
136136

137137
If you plan a pool with more than 300 compute nodes, you might need to resize the pool multiple times to reach the target size.
138138

139-
By using the [Shared Image Gallery](batch-sig-images.md), you can create larger pools with your customized images along with more Shared Image replicas. Using Shared Images, the time it takes for the pool to reach the steady state is up to 25% faster, and the VM idle latency is up to 30% shorter.
139+
By using the [Azure Compute Gallery](batch-sig-images.md), you can create larger pools with your customized images along with more Shared Image replicas. Using Shared Images, the time it takes for the pool to reach the steady state is up to 25% faster, and the VM idle latency is up to 30% shorter.
140140

141141
## Considerations for using Packer
142142

@@ -150,5 +150,5 @@ For more information on using Packer to create a VM, see [Build a Linux image wi
150150

151151
## Next steps
152152

153-
- Learn how to use the [Shared Image Gallery](batch-sig-images.md) to create a custom pool.
153+
- Learn how to use the [Azure Compute Gallery](batch-sig-images.md) to create a custom pool.
154154
- For an in-depth overview of Batch, see [Batch service workflow and resources](batch-service-workflow-features.md).

articles/batch/batch-linux-nodes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ When you create a pool of compute nodes in Batch, you have two options from whic
1515

1616
### Virtual machine image reference
1717

18-
The Batch service uses [virtual machine scale sets](../virtual-machine-scale-sets/overview.md) to provide compute nodes in the Virtual Machine Configuration. You can specify an image from the [Azure Marketplace](https://azuremarketplace.microsoft.com/marketplace/apps/category/compute?filters=virtual-machine-images&page=1), or [use the Shared Image Gallery to prepare a custom image](batch-sig-images.md).
18+
The Batch service uses [virtual machine scale sets](../virtual-machine-scale-sets/overview.md) to provide compute nodes in the Virtual Machine Configuration. You can specify an image from the [Azure Marketplace](https://azuremarketplace.microsoft.com/marketplace/apps/category/compute?filters=virtual-machine-images&page=1), or [use the Azure Compute Gallery to prepare a custom image](batch-sig-images.md).
1919

2020
When you create a virtual machine image reference, you must specify the following properties:
2121

articles/batch/batch-pool-compute-intensive-sizes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ To run CUDA applications on a pool of Linux NC nodes, you need to install necess
110110
1. Deploy an Azure NC-series VM running Ubuntu 16.04 LTS. For example, create the VM in the US South Central region.
111111
2. Add the [NVIDIA GPU Drivers extension](../virtual-machines/extensions/hpccompute-gpu-linux.md
112112
) to the VM by using the Azure portal, a client computer that connects to the Azure subscription, or Azure Cloud Shell. Alternatively, follow the steps to connect to the VM and [install CUDA drivers](../virtual-machines/linux/n-series-driver-setup.md) manually.
113-
3. Follow the steps to create a [Shared Image Gallery image](batch-sig-images.md) for Batch.
113+
3. Follow the steps to create an [Azure Compute Gallery image](batch-sig-images.md) for Batch.
114114
4. Create a Batch account in a region that supports NC VMs.
115115
5. Using the Batch APIs or Azure portal, create a pool [using the custom image](batch-sig-images.md) and with the desired number of nodes and scale. The following table shows sample pool settings for the image:
116116

@@ -129,8 +129,8 @@ To run Windows MPI applications on a pool of Azure H16r VM nodes, you need to co
129129
2. Add the HpcVmDrivers extension to the VM by [running an Azure PowerShell command](../virtual-machines/sizes-hpc.md) from a client computer that connects to your Azure subscription, or using Azure Cloud Shell.
130130
1. Make a Remote Desktop connection to the VM.
131131
1. Download the [setup package](https://www.microsoft.com/download/details.aspx?id=57467) (MSMpiSetup.exe) for the latest version of Microsoft MPI, and install Microsoft MPI.
132-
1. Follow the steps to create a [Shared Image Gallery image](batch-sig-images.md) for Batch.
133-
1. Using the Batch APIs or Azure portal, create a pool [using the Shared Image Gallery](batch-sig-images.md) and with the desired number of nodes and scale. The following table shows sample pool settings for the image:
132+
1. Follow the steps to create an [Azure Compute Gallery image](batch-sig-images.md) for Batch.
133+
1. Using the Batch APIs or Azure portal, create a pool [using the Azure Compute Gallery](batch-sig-images.md) and with the desired number of nodes and scale. The following table shows sample pool settings for the image:
134134

135135
| Setting | Value |
136136
| ---- | ---- |

articles/batch/batch-pool-node-error-checking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Common causes for resize errors include:
3535
- Insufficient resources when a [pool is in a virtual network](./batch-virtual-network.md)
3636
- You might create resources such as load-balancers, public IPs, and network security groups in the same subscription as the Batch account. Check that the subscription quotas are sufficient for these resources.
3737
- Large pools with custom VM images
38-
- Large pools that use custom VM images can take longer to allocate and resize timeouts can occur. See [Create a pool with the Shared Image Gallery](batch-sig-images.md) for recommendations on limits and configuration.
38+
- Large pools that use custom VM images can take longer to allocate and resize timeouts can occur. See [Create a pool with the Azure Compute Gallery](batch-sig-images.md) for recommendations on limits and configuration.
3939

4040
### Automatic scaling failures
4141

articles/batch/batch-rendering-functionality.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ For an overview of Batch concepts, including pools, jobs, and tasks, see [this a
1515

1616
## Batch pools using custom VM images and standard application licensing
1717

18-
As with other workloads and types of application, a custom VM image can be created with the required rendering applications and plug-ins. The custom VM image is placed in the [Shared Image Gallery](../virtual-machines/shared-image-galleries.md) and [can be used to create Batch Pools](batch-sig-images.md).
18+
As with other workloads and types of application, a custom VM image can be created with the required rendering applications and plug-ins. The custom VM image is placed in the [Azure Compute Gallery](../virtual-machines/shared-image-galleries.md) and [can be used to create Batch Pools](batch-sig-images.md).
1919

2020
The task command line strings will need to reference the applications and paths used when creating the custom VM image.
2121

@@ -41,8 +41,8 @@ The Azure portal and Batch Explorer provide GUI tools to select a rendering VM i
4141

4242
Other options are available if additional applications are required on the pool VMs:
4343

44-
* A custom image from the Shared Image Gallery:
45-
* Using this option, you can configure your VM with the exact applications and specific versions that you require. For more information, see [Create a pool with the Shared Image Gallery](batch-sig-images.md). Autodesk and Chaos Group have modified Arnold and V-Ray, respectively, to validate against an Azure Batch licensing service. Make sure you have the versions of these applications with this support, otherwise the pay-per-use licensing won't work. Current versions of Maya or 3ds Max don't require a license server when running headless (in batch/command-line mode). Contact Azure support if you're not sure how to proceed with this option.
44+
* A custom image from the Azure Compute Gallery:
45+
* Using this option, you can configure your VM with the exact applications and specific versions that you require. For more information, see [Create a pool with the Azure Compute Gallery](batch-sig-images.md). Autodesk and Chaos Group have modified Arnold and V-Ray, respectively, to validate against an Azure Batch licensing service. Make sure you have the versions of these applications with this support, otherwise the pay-per-use licensing won't work. Current versions of Maya or 3ds Max don't require a license server when running headless (in batch/command-line mode). Contact Azure support if you're not sure how to proceed with this option.
4646
* [Application packages](./batch-application-packages.md):
4747
* Package the application files using one or more ZIP files, upload via the Azure portal, and specify the package in pool configuration. When pool VMs are created, the ZIP files are downloaded and the files extracted.
4848
* Resource files:

articles/batch/batch-sig-images.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: Use the Shared Image Gallery to create a custom image pool
2+
title: Use the Azure Compute Gallery to create a custom image pool
33
description: Custom image pools are an efficient way to configure compute nodes to run your Batch workloads.
44
ms.topic: conceptual
55
ms.date: 03/04/2021
66
ms.custom: devx-track-python, devx-track-azurecli
77
---
88

9-
# Use the Shared Image Gallery to create a custom image pool
9+
# Use the Azure Compute Gallery to create a custom image pool
1010

11-
When you create an Azure Batch pool using the Virtual Machine Configuration, you specify a VM image that provides the operating system for each compute node in the pool. You can create a pool of virtual machines either with a supported Azure Marketplace image or create a custom image with a [Shared Image Gallery image](../virtual-machines/shared-image-galleries.md).
11+
When you create an Azure Batch pool using the Virtual Machine Configuration, you specify a VM image that provides the operating system for each compute node in the pool. You can create a pool of virtual machines either with a supported Azure Marketplace image or create a custom image with a [Azure Compute Gallery image](../virtual-machines/shared-image-galleries.md).
1212

13-
## Benefits of the Shared Image Gallery
13+
## Benefits of the Azure Compute Gallery
1414

15-
When you use the Shared Image Gallery for your custom image, you have control over the operating system type and configuration, as well as the type of data disks. Your Shared Image can include applications and reference data that become available on all the Batch pool nodes as soon as they are provisioned.
15+
When you use the Azure Compute Gallery for your custom image, you have control over the operating system type and configuration, as well as the type of data disks. Your Shared Image can include applications and reference data that become available on all the Batch pool nodes as soon as they are provisioned.
1616

1717
You can also have multiple versions of an image as needed for your environment. When you use an image version to create a VM, the image version is used to create new disks for the VM.
1818

@@ -24,7 +24,7 @@ Using a Shared Image configured for your scenario can provide several advantages
2424
- **Configure the operating system (OS).** You can customize the configuration of the image's operating system disk.
2525
- **Pre-install applications.** Pre-installing applications on the OS disk is more efficient and less error-prone than installing applications after provisioning the compute nodes with a start task.
2626
- **Copy large amounts of data once.** Make static data part of the managed Shared Image by copying it to a managed image's data disks. This only needs to be done once and makes data available to each node of the pool.
27-
- **Grow pools to larger sizes.** With the Shared Image Gallery, you can create larger pools with your customized images along with more Shared Image replicas.
27+
- **Grow pools to larger sizes.** With the Azure Compute Gallery, you can create larger pools with your customized images along with more Shared Image replicas.
2828
- **Better performance than using just a managed image as a custom image.** For a Shared Image custom image pool, the time to reach the steady state is up to 25% faster, and the VM idle latency is up to 30% shorter.
2929
- **Image versioning and grouping for easier management.** The image grouping definition contains information about why the image was created, what OS it is for, and information about using the image. Grouping images allows for easier image management. For more information, see [Image definitions](../virtual-machines/shared-image-galleries.md#image-definitions).
3030

@@ -35,14 +35,14 @@ Using a Shared Image configured for your scenario can provide several advantages
3535
3636
- **An Azure Batch account.** To create a Batch account, see the Batch quickstarts using the [Azure portal](quick-create-portal.md) or [Azure CLI](quick-create-cli.md).
3737

38-
- **A Shared Image Gallery image**. To create a Shared Image, you need to have or create a managed image resource. The image should be created from snapshots of the VM's OS disk and optionally its attached data disks.
38+
- **an Azure Compute Gallery image**. To create a Shared Image, you need to have or create a managed image resource. The image should be created from snapshots of the VM's OS disk and optionally its attached data disks.
3939

4040
> [!NOTE]
4141
> If the Shared Image is not in the same subscription as the Batch account, you must [register the Microsoft.Batch resource provider](../azure-resource-manager/management/resource-providers-and-types.md#register-resource-provider) for that subscription. The two subscriptions must be in the same Azure AD tenant.
4242
>
4343
> The image can be in a different region as long as it has replicas in the same region as your Batch account.
4444
45-
If you use an Azure AD application to create a custom image pool with a Shared Image Gallery image, that application must have been granted an [Azure built-in role](../role-based-access-control/rbac-and-directory-admin-roles.md#azure-roles) that gives it access to the the Shared Image. You can grant this access in the Azure portal by navigating to the Shared Image, selecting **Access control (IAM)** and adding a role assignment for the application.
45+
If you use an Azure AD application to create a custom image pool with an Azure Compute Gallery image, that application must have been granted an [Azure built-in role](../role-based-access-control/rbac-and-directory-admin-roles.md#azure-roles) that gives it access to the the Shared Image. You can grant this access in the Azure portal by navigating to the Shared Image, selecting **Access control (IAM)** and adding a role assignment for the application.
4646

4747
## Prepare a Shared Image
4848

@@ -82,9 +82,9 @@ A snapshot is a full, read-only copy of a VHD. To create a snapshot of a VM's OS
8282

8383
To create a managed image from a snapshot, use Azure command-line tools such as the [az image create](/cli/azure/image) command. Create an image by specifying an OS disk snapshot and optionally one or more data disk snapshots.
8484

85-
### Create a Shared Image Gallery
85+
### Create an Azure Compute Gallery
8686

87-
Once you have successfully created your managed image, you need to create a Shared Image Gallery to make your custom image available. To learn how to create a Shared Image Gallery for your images, see [Create a Shared Image Gallery](../virtual-machines/create-gallery.md).
87+
Once you have successfully created your managed image, you need to create an Azure Compute Gallery to make your custom image available. To learn how to create an Azure Compute Gallery for your images, see [Create an Azure Compute Gallery](../virtual-machines/create-gallery.md).
8888

8989
## Create a pool from a Shared Image using the Azure CLI
9090

@@ -174,7 +174,7 @@ start_task = batchmodels.StartTask(
174174
start_task.run_elevated = True
175175

176176
# Create an ImageReference which specifies the image from
177-
# Shared Image Gallery to install on the nodes.
177+
# Azure Compute Gallery to install on the nodes.
178178
ir = batchmodels.ImageReference(
179179
virtual_machine_image_id="/subscriptions/{sub id}/resourceGroups/{resource group name}/providers/Microsoft.Compute/galleries/{gallery name}/images/{image definition name}/versions/{version id}"
180180
)
@@ -207,7 +207,7 @@ Use the following steps to create a pool from a Shared Image in the Azure portal
207207
1. Open the [Azure portal](https://portal.azure.com).
208208
1. Go to **Batch accounts** and select your account.
209209
1. Select **Pools** and then **Add** to create a new pool.
210-
1. In the **Image Type** section, select **Shared Image Gallery**.
210+
1. In the **Image Type** section, select **Azure Compute Gallery**.
211211
1. Complete the remaining sections with information about your managed image.
212212
1. Select **OK**.
213213

@@ -217,11 +217,11 @@ Use the following steps to create a pool from a Shared Image in the Azure portal
217217

218218
If you plan to create a pool with hundreds or thousands of VMs or more using a Shared Image, use the following guidance.
219219

220-
- **Shared Image Gallery replica numbers.** For every pool with up to 300 instances, we recommend you keep at least one replica. For example, if you are creating a pool with 3000 VMs, you should keep at least 10 replicas of your image. We always suggest keeping more replicas than minimum requirements for better performance.
220+
- **Azure Compute Gallery replica numbers.** For every pool with up to 300 instances, we recommend you keep at least one replica. For example, if you are creating a pool with 3000 VMs, you should keep at least 10 replicas of your image. We always suggest keeping more replicas than minimum requirements for better performance.
221221

222222
- **Resize timeout.** If your pool contains a fixed number of nodes (if it doesn't autoscale), increase the `resizeTimeout` property of the pool depending on the pool size. For every 1000 VMs, the recommended resize timeout is at least 15 minutes. For example, the recommended resize timeout for a pool with 2000 VMs is at least 30 minutes.
223223

224224
## Next steps
225225

226226
- For an in-depth overview of Batch, see [Batch service workflow and resources](batch-service-workflow-features.md).
227-
- Learn about the [Shared Image Gallery](../virtual-machines/shared-image-galleries.md).
227+
- Learn about the [Azure Compute Gallery](../virtual-machines/shared-image-galleries.md).

0 commit comments

Comments
 (0)