Configure SXA for deployment on the Azure App Service

Last updated Monday, July 3, 2017 in Sitecore Experience Accelerator for Content Author
Keywords: Cloud, Configuration

From Sitecore 8.2.3, SXA 1.3.1, SPE 4.5, and SAT onwards, you can install the Sitecore Experience Accelerator (SXA) module as part of the Sitecore installation on the Azure App Service. The SXA module installation is fully integrated and supports the following Sitecore configurations: XP0, XP, and XM.

To install SXA as part of the Sitecore installation on the Azure App Service, you must have the following:

  • Sitecore XP 8.2 Update-3 or later
  • Sitecore Azure Toolkit 1.1

This topic describes how to:

Note

Depending on which environment you want to configure (XP0, XM, or XP), after you have prepared to deploy SXA and injected the SXA module into the Sitecore XP .parameters.json file, you either Populate the SXA module parameters for XP0 environment or Populate the SXA module parameters for a Sitecore XP environment.

Prepare to deploy SXA

To prepare to deploy the SXA module:

  1. Download the Web Deploy Packages (WDPs) for SXA.
  2. Upload the WDPs to a storage account.
  3. Locate the SXA template for your topology on GitHub.
  4. Inject the SXA module into the Sitecore.parameters.json file for your topology.

Inject the SXA module into the Sitecore .parameters.json file

To inject the SXA module into the Sitecore .parameters.json file for your topology:

  1. Go to Deploy a new Sitecore environment to the Azure App service, Download and configure section, and ensure you have a .parameters.json file for your Sitecore environment.
  2. Add the modules parameter to the .parameters.json file and configure the Bootloader module for a Sitecore deployment.
  3. Insert the configuration snippet for the SXA module to the modules parameter in the .parameters.json file for your Sitecore configuration in Populate the SXA module parameters for an XP0 environment and Populate the SXA module parameters for an XM / XP1 environment.
  4. Run your Sitecore deployment as usual.

Populate the SXA module parameters for an XP0 environment

To integrate an SXA deployment into a Sitecore XP0 environment deployment:

  1. In the .parameters.json file, add the following snippet to the modules parameter:
    {... ,
      "modules": {
        "value": {
          "items": [
            ... ,
            {
            "name" : "sxa",
            "templateLink" : "<url of SXA azuredeploy.json for XP0 topology>",
            "parameters" : {
              "sxaMsDeployPackageUrl": "<url of the WDP package>",
              "speMsDeployPackageUrl": "<url of the WDP package>"
              }
            }
          ]
        }
      }
    }
  2. Populate the parameters for the SXA module as follows:

    Parameter

    Instruction

    templateLink

    Go to Github and use the URL of the SXA template for your selected topology, or your storage account.

    sxaMsDeployPackageUrl

    Go to the Sitecore Dev Portal and download the latest version of the sxa.scwdp.zip package for Sitecore Experience Accelerator 1.3, and use the URL of the WDP package for SXA.

    speMsDeployPackageUrl

    Go to the Sitecore Dev Portal and download the latest version of the spe.scwdp.zip package for the Sitecore Powershell Extensions 4.5, and use the URL of the WDP package for SPE.

  3. To run your Sitecore deployment, go to Deploy a new Sitecore environment to the Azure App Service, Invoke the deployment section.

Populate the SXA module parameters for an XM / XP1 environment

To integrate your SXA deployment into a Sitecore XM / XP1 environment deployment:

  1. In the .parameters.json file, add the following snippet to the modules parameter:
    {... ,
      "modules": {
        "value": {
          "items": [
            ... ,
            {
            "name" : "sxa",
            "templateLink" : "<url of SXA azuredeploy.json for XM topology>",
            "parameters" : {
              "cdSxaMsDeployPackageUrl": "<url of the WDP package>",
              "cmSxaMsDeployPackageUrl": "<url of the WDP package>",
              "speMsDeployPackageUrl": "<url of the WDP package>",
              }
            }
          ]
        }
      }
    }
  2. Populate the parameters for the SXA module as follows:

    Parameter

    Instruction

    templateLink

    Go to Github and use the URL of the SXA template for your selected topology, or your storage account.

    cmSxaMsDeployPackageUrl

    Go to the Sitecore Dev Portal and download the latest version of the sxa.scwdp.zip package for Sitecore Experience Accelerator 1.3, and use the URL of the WDP package for SXA.

    cdSxaMsDeployPackageUrl

    Go to the Sitecore Dev Portal and download the latest version of the sxaCD.scwdp.zip package for Sitecore Experience Accelerator 1.3.1 CD, and use the URL of the WDP package for SXA CD.

    speMsDeployPackageUrl

    Go to the Sitecore Dev Portal and download the latest version of the spe.scwdp.zip package for Sitecore Powershell Extensions 4.5, and use the URL of the WDP package for SPE.

  3. To run your Sitecore deployment, go to Deploy a new Sitecore environment to the Azure App Service, Invoke the deployment section.