Prepare an Azure Stack Hub update package

Article
11/25/2021

This article provides an overview of preparing Azure Stack Hub update packages so they can be used to update your Azure Stack Hub environment. This process consists of the following steps:

Download the update package.
Import the update package into your Azure Stack Hub environment using the Azure Stack Hub administrator portal.

On systems that can connect to the automatic update endpoints, Azure Stack Hub software updates and hotfixes are automatically downloaded and prepared. On systems without connectivity, and for any update from the original equipment manufacturer (OEM), the update package must be prepared as explained in this article.

The following table shows when update packages require manual preparation and when they're prepared automatically.

Update Type	Connectivity	Action Required
Azure Stack Hub software updates	Connected	Update is automatically downloaded and prepared when the update is applied.
Azure Stack Hub hotfixes	Connected	Update is automatically downloaded and prepared when the update is applied.
OEM package updates	Connected	The update package must be prepared. Follow the steps in this article.
Azure Stack Hub software updates	Disconnected or weak connection	The update package must be prepared. Follow the steps in this article.
Azure Stack Hub hotfixes	Disconnected or weak connection	The update package must be prepared. Follow the steps in this article.
OEM package updates	Disconnected or weak connection	The update package must be prepared. Follow the steps in this article.

Download the update package

The update package for Azure Stack Hub updates and hotfixes is available for connected systems through the update blade in the portal. Download the package and move the package to a location that's accessible to your Azure Stack Hub instance if you're updating an OEM package or if you're supporting a disconnected system. You also might need to download and then upload the package to an accessible location if you're running a system with an intermittent connection.

Review the package contents. An update package typically consists of the following files:

One or more .zip files named <PackageName>.zip. These files contain the payload for the update.
A metadata.xml file. This file contains essential information about the update; for example, the publisher, name, prerequisite, size, and support path URL.

SHA256 hashes are computed for the .zip file(s) with update package content and inserted into the metadata.xml associated with the package. The metadata.xml file itself is signed with an embedded signature using a certificate trusted by the Azure Stack Hub system.

Automatic download and preparation for update packages

Azure Stack Hub software updates and hotfixes are prepared automatically for systems with connectivity to the Azure Stack Hub automatic update endpoints: https://*.azureedge.net and https://aka.ms/azurestackautomaticupdate. For more information about setting up connectivity to the Azure Stack Hub automatic update endpoints, see the Patch and Update endpoints described in Azure Stack Hub firewall integration.

Where to download Azure Stack Hub update packages

Azure Stack Hub updates for full and express updates are hosted at a secure Azure endpoint. When updates become available, Azure Stack Hub operators with connected instances will see the Azure Stack Hub updates automatically appear in the administrator portal.

For disconnected systems or systems with weak internet connectivity, full update packages can be downloaded using the Azure Stack Hub updates downloader tool. Hotfix packages can be downloaded from the hotfix KB link listed in Azure Stack Hub release notes. Azure Stack Hub software update packages may contain updates to Azure Stack Hub services and updates to the operating system of your Azure Stack Hub's scale units.

Note

The update package itself and its contents (such as binaries, PowerShell scripts, and so on) are signed with Microsoft-owned certificates. Tampering with the package will make the signature invalid.

Where to download Azure Stack Hub hotfix packages

Packages for Azure Stack Hub hotfixes are hosted in the same secure Azure endpoint as Azure Stack Hub updates. Azure Stack Hub operators with connected instances will see the Azure Stack Hub updates automatically appear in the administrator portal when they become available. You can download them using the embedded links in each of the respective hotfix KB articles. You can also find links to hotfix KB articles in the release notes corresponding to your Azure Stack Hub version.

Where to download OEM update packages

Your OEM vendor might also release updates, such as driver and firmware updates. While these updates are delivered as separate OEM package updates by your hardware vendor, they're still imported, installed, and managed the same way as update packages from Microsoft. You can find a list of vendor contact links in the article Apply Azure Stack Hub OEM updates.

Import and install updates

The following procedure shows how to import and install update packages in the administrator portal.

Important

Notify users of any maintenance operations, and ensure you schedule normal maintenance windows during non-business hours as much as possible. Maintenance operations can affect both user workloads and portal operations.

In the administrator portal, select All services. Then, under the STORAGE category, select Storage accounts. Or, in the filter box, start typing storage accounts, and then select it.
In the filter box, type update, and select the updateadminaccount storage account.
In All services, under Essentials or Blob service, select Containers.
In Containers, select + Container to create a container. Enter a name (for example, update-2102), and then select Create.
After the container is created, select the container name, and then select Upload to upload the package files to the container.
Under Upload blob, select the folder icon, browse to the update package .zip file, and then select Open in the file explorer window.
Under Upload blob, select Upload.
Repeat steps 6 and 7 for the Metadata.xml file and any additional .zip files in the update package. Don't import the Supplemental Notice.txt file if included.
When done, you can review the notifications (select the bell icon in the top-right corner of the portal). A notification should indicate that the upload has finished.
Go back to the Update blade on the dashboard. The blade should show that an update is available. This indicates that the update has been prepared successfully. Select the blade to review the newly-added update package.
Verify no updates are running. If an update is installing, an alert banner displays The exclusive operation is in progress. Additional update operations are disabled while the operation is running. Wait for the update to finish before starting another update.
To install the update, select the package that's marked as Ready, and then select Update now.
When you select the installing update package, you can view the status in the Update run details area. From here, you can also select Download summary to download the log files. Logs from update runs are available for six months after the attempt ended.
When the update finishes, the Update blade shows the updated Azure Stack Hub version.

You can manually delete updates from the storage account after they've been installed on Azure Stack Hub. Azure Stack Hub periodically checks for older update packages and removes them from storage. It may take Azure Stack Hub up to two weeks to remove the old packages.

Next steps

Apply the update