Apply updates to cloud environments
This topic describes how you can use Microsoft Dynamics Lifecycle Services (LCS) to automatically apply updates to cloud environments.
Updates are applied using deployable packages. Applying updates causes system downtime. All relevant services will be stopped, and you won't be able to use your environments while the package is being applied. You should plan accordingly.
All customer-managed and Microsoft-managed environments deployed through Lifecycle Services are supported. For more information about self-service environments, see Update an environment.
If you have a build environment, you can only use LCS to apply Binary updates and Data upgrade packages. You can't use LCS to apply an Application Deployable package.
For other environments (listed below), you must use Remote Desktop Protocol (RDP) to connect to the environment and install from the command line. For information about manual package deployment, see Install deployable packages from the command line.
- Local development environments (Downloadable virtual hard disk [VHD])
- Multi-box dev/test environments in Microsoft Azure (Partner and trial projects)
Before you begin, you should understand deployable packages, runbooks, and the AXInstaller. A deployable package is a unit of deployment that can be applied in any environment. A deployable package can be a binary update to the platform or other runtime components, an updated application (AOT) package, or a new application (AOT) package. The AXInstaller creates a runbook that enables installing a package. For more details, see Packages, runbooks, and the AXUpdateInstaller in depth at the end of this topic.
Supported package types
- AOT deployable package – A deployable package that is generated from application metadata and source code. This deployable package is created in a development or build environment.
- Application and Platform Binary update package – A deployable package that contains dynamic-link libraries (DLLs) and other binaries and metadata that the platform and application depend on. This is a package released by Microsoft. This is available from the All binary updates tile from LCS.
- Platform update package – A deployable package that contains dynamic-link libraries (DLLs) and other binaries and metadata that the platform depend on. This is a package released by Microsoft. This is available from the Platform binary updates tile from LCS.
- Commerce deployable package – A combination of various packages that are generated after the Commerce code is combined.
- Merged package – A package that is created by combining one package of each type. For example, you can merge one binary update package and one AOT package, or one AOT package and one Commerce deployable package. The packages are merged in the Asset library for the project in LCS.
A binary package and a Commerce deployable package can't be included in the same merged package.
For information about how to download an update from LCS and what you see in the tiles based on your environment version, see Download updates from Lifecycle Services (LCS).
If your environment is on an application version 8.1 and later, then the Platform Update package does not apply to your environment. Starting with 8.1 and later releases, Application and Platform Binary update package is the one that applies since application and platform will be combined into a single cumulative package and will be released by Microsoft. Also note that you will no longer be applying granular X++ hotfixes and will get all application and platform updates together. This means that on the environment details page, clicking on View detailed version information will not have details on the granular hotfixes or KBs applied as there is no way to apply them.
Make sure that the package that should be applied is valid. When a package is uploaded to the Asset library, it isn't analyzed. If you select the package, the package status appears in the right pane as Not Validated. A package must pass validation before it can be applied in an environment by using the following procedures. The status of the package will be updated in the Asset library to indicate whether the package is valid. We require validation to help ensure that production environments aren't affected by packages that don't meet the guidelines.
There are three types of validations:
- Basic package format validations
- Platform version checks
- Types of packages
Make sure that the package is applied in a sandbox environment before it's applied in the production environment. To help ensure that the production environment is always in a good state, we want to make sure that the package is tested in a sandbox environment before it's applied in the production environment. Therefore, before you request that the package be applied in your production environment, make sure that it has been applied in your sandbox environment by using the automated flows.
If you want to apply multiple packages, create a merged package that can be applied first in a sandbox environment and then in the production environment. Application of a single package in an average environment requires about 5 hours of downtime. To avoid additional hours of downtime when you must apply multiple packages, you can create a single combined package that contains one package of each type. If you select a binary package and an application deployable package in the Asset library, a Merge button becomes available on the toolbar. By clicking this button, you can merge the two packages into a single package and therefore reduce the total downtime by half.
Make sure that the application binary update package is applied to your dev/build environment AFTER it is applied to your sandbox and production environment - If the application binary package is applied on your dev/build environment and this raises the platform build version to be higher than your target sandbox or production environment, you will be blocked from applying any AOT packages that are produced from this dev/build environment. To apply AOT packages produced from a dev/build environment, your dev/build instance must be equal to or lower than your target environments.
Apply a package to a non-production environment by using LCS
For self-service type environments, see Update an environment.
Before you begin, verify that the deployable package has been uploaded to the Asset library in LCS.
- For a binary update, upload the package directly to the Asset library. For information about how to download an update from LCS, see Download updates from Lifecycle Services (LCS). For an application (AOT) deployable package that results from an X++ hotfix, or from application customizations and extensions, create the deployable package in your development or build environment, and then upload it to the Asset library.
- Open the Environment details view for the environment where you want to apply the update.
- Click Maintain > Apply updates to apply an update.
- Select the package to apply. Use the filter at the top to find your package.
- Click Apply. Notice that the status in the upper-right corner of the Environment details view changes from Queued to In Progress, and an Environment updates section now shows the progress of the package. You can refresh the page to check the status.
- Continue to refresh the page to see the status updates for the package application request. When the package has been applied, the environment status changes to Deployed, and the servicing status changes to Completed.
Apply a package to a production environment by using LCS
In a production environment, customers can schedule a downtime for when they want the update to be applied. For self-service type environments, see Update an environment.
An important prerequisite for applying a package to a production environment is that the package must be successfully applied to at least one sandbox environment in the same project.
After the update is successfully applied in a sandbox environment, go to the project's asset library. On the Asset library page, select the Software deployable package tab, select the package that you want to move to production, and click Release candidate. This indicates that this package is ready for production deployment.
Open the Environment details view for the production environment where you want to apply the package.
Select Maintain > Apply updates to apply the package.
Select the package to apply in your production environment, and then click Schedule to submit a request to apply it.
The list of packages includes only the packages that have been successfully signed off in the sandbox environment, and that have been marked as release candidates.
Specify the date and time to schedule the package application. Click Submit, and then click OK to confirm. Note that your environments will be unavailable to perform business while the package is being applied.
At the scheduled downtime, package deployment will start.
After the environment is serviced, you can monitor the status. The Servicing status field indicates the status of package application. Additionally, a progress indicator shows the number of steps that have been run, out of the total number of steps that are available.
After the deployment is successfully completed, the Servicing status field is set to Completed.
If package application isn't successfully completed, Microsoft will investigate the issue. The Servicing status field will indicate that package application has failed. The environment will be rolled back to a good state.
Troubleshoot package deployment failures
If package deployment fails, see Troubleshoot package application issues.
Applying updates and extensions
If you are updating a Tier-2 Sandbox or Production environment on application version 8.1.2.x or newer and have initialized Cloud Scale Unit, you will also need to update Commerce channel components. For more information, see Update Retail Cloud Scale Unit.
If you're using components (such as Modern POS), after you've applied updates and extensions in your environment, you must also update your in-store components. For more information, see Configure, install, and activate Modern POS (MPOS).
Packages, runbooks, and the AXUpdateInstaller in depth
Deployable packages, runbooks, and the AXUpdateInstaller are the tools you use to apply updates.
Deployable package – A deployable package is a unit of deployment that can be applied in an environment. A deployable package can be a binary update to the platform or other runtime components, an updated application (AOT) package, or a new application (AOT) package. Deployable packages downloaded from LCS or created in a development environment cannot be applied across product types. For example, a Finance deployable package cannot be applied in a Commerce app environment, and vice versa. If you have an existing customization for a Finance and Operations app that is compatible with the Commerce app, and you would like to apply it to a Commerce environment, you will need to re-package your source code in a Commerce development environment, and conversely if moving in the other direction.
Runbook – The deployment runbook is a series of steps that are generated in order to apply the deployable package to the target environment. Some steps are automated, and some steps are manual. AXUpdateInstaller lets you run these steps one at a time and in the correct order.
AXUpdateInstaller – When you create a customization package from Microsoft Visual Studio or a Microsoft binary update, the installer executable is bundled together with the deployable package. The installer generates the runbook for the specified topology. The installer can also run steps in order, according to the runbook for a specific topology.