SitecoreDXG Documention
  • SitecoreDXG: The Documentation Experience Generator
  • Overview
    • SitecoreDXG: The Documentation Experience Generator
    • Comparison with SitecoreUML
    • CI/CD Integration
    • Helix Dependency Validation
  • Getting Started
    • Compatibility and System Requirements
    • Installing SitecoreDXG
      • General Installation
        • 1. Install the SitecoreDXG Generation Service
        • 2. Install RabbitMQ
        • 3. Install the SitecoreUML Service for Sitecore
        • 4. (Optional) Configure the Documentation Configuration Item for your Solution
        • 5. Install the Default RabbitMQ Middleman in a Custom Location
        • 6. (Optional) Integrate SitecoreDXG into your CI/CD Pipeline
      • Developer Installation
        • 1. Install the SitecoreDXG Generation Service for Developers
        • 2. Install RabbitMQ for Developers
        • 3. Install the SitecoreUML Service for Sitecore for Developers
        • 4. (Optional) Configure the Documentation Configuration Item for your Solution
        • 5. (Optional) Install the Default RabbitMQ Middleman for Developers
        • 6. (Optional) Integrate SitecoreDXG into your CI/CD Pipeline for Developers
    • Upgrading and Downgrading
    • Downloads
    • Using SitecoreDXG
      • Using the Default RabbitMQ Middleman and Trigger
        • Using the DocumentationConfiguration Object
      • Using the Provided AWS S3 Deploy Completion Handler
      • Using the Provided Azure Blob Storage Deploy Completion Handler
  • Architecture
    • Architecture Overview
    • Roles
      • Role Combinations
    • Components
    • Plugins
      • Trigger Plugins
      • Completion Handler Plugins
    • Middlemen
    • Understanding the Default RabbitMQ Middleman and Trigger
  • How To
    • CI/CD Integration
      • Integrating SitecoreDXG into your CI/CD Pipeline
      • Integrating the Default TeamCity RabbitMQ Meta-Runner
    • Creating a Custom Trigger
      • Executing Documentation Generation
      • Executing Meta-Data JSON Generation
    • Slack and Microsoft Teams Integration
      • Integrating with Slack via Webhooks
      • Integrating with Microsoft Teams via Webhooks
    • Creating a Custom Completion Handler
    • Creating a Custom Middleman
    • Viewing Helix Validation Errors
  • About the Generated Documentation
    • Overview
    • Models
      • Template Model
      • Template Field Model
      • Template Folder Model
      • Parent-Child Relationships of Models
      • Inheritance Relationship Model
      • Dependency Relationship Model
    • Views
      • Template View
      • Template Field View
      • Template Folder View
      • Parent-Child Relationship View
      • Inheritance Relationship View
      • Dependency Relationship View
    • Diagrams
      • SitecoreUML Syntax
      • Templates Diagram
      • Template Folders Diagram
      • Layer Diagrams
      • Module Diagrams
      • Module Templates Diagrams
    • Samples
Powered by GitBook
On this page
  • Setup
  • Parameters
  • Important Note About Folders in Azure Blob Storage
  • Calling the Azure Blob Storage Deploy Handler Data from the Middleman
  1. Getting Started
  2. Using SitecoreDXG

Using the Provided Azure Blob Storage Deploy Completion Handler

PreviousUsing the Provided AWS S3 Deploy Completion HandlerNextArchitecture Overview

Last updated 6 years ago

SitecoreDXG includes the Azure Blob Storage Deploy Completion Handler for deploying the generated output to an Azure Blob Storage container. Using this completion handler, you can rapidly configure your CI/CD infrastructure to generate updated Sitecore template architecture documentation on every build, and then publish the generated HTML-based documentation to Azure for live viewing. This ensures that you always have an up-to-date and live documentation site for your architecture that you can optionally share with clients, internal teams, or other groups and individuals.

Important Note about Azure Blob Storage and Static Website Hosting

It should be noted that directly from Azure Blob Storage is, as of the date of this writing, in . The functionality was released to preview in August, and appears to be working correctly in tests run prior to and following the development of this completion handler. It is not expected that the completion handler will require any significant changes after the static hosting feature exits technical preview for an initial release.

Setup

  1. Go to the and create and/or retrieve the details for the Azure Blob Storage account and container that you want to use. You will need the connection string for your ABS account, the name of the container that you want to deploy to (must exist, and should be $web as it is created automatically when enabling your storage account for Static Hosting) and (optionally) the name of the directory within that container that you want to deploy to

    1. See the instructions provided by Azure for more information

    2. IMPORTANT: make sure that you select "General Purpose v2" (GPv2) for your storage account type, as this cannot be changed later and currently only GPv2 supports static website hosting

  2. (Optional) if you wish to set the completion handler as the default then update the DefaultCompletionHandlers property in the ./settings.js file of the SitecoreDXG Generation Service with required settings for calling the completion handler

  3. If you are running the SitecoreDXG Generation Service as a Windows service then you need to restart the service

WARNING: You should always deploy to an empty directory

The ABS Deploy Completion Handler is designed to perform clean deployments, meaning that any files in the targeted deployment directory in the Azure Blob Storage container will be deleted immediately prior to the deployment. You can use the AzureStorageTargetDirectory parameter to set the target deployment location to somewhere other than the container's root (the default). Note that anything in the target directory (or the root if the target directory is not set) will be deleted.

Parameters

The Azure Blob Storage Deploy Completion Handler requires a JSON object parameter with the following syntax:

{
    "AzureStorageAccountConnectionString": "YOUR_ABS_CONNECTION_STRING",
    "AzureStorageContainer": "$web",
    "AzureStorageTargetDirectory": "MySite/UAT"
}
[{
    "ID": "Azure_ABS",
    "Params": {
        "AzureStorageAccountConnectionString": "YOUR_ABS_CONNECTION_STRING",
        "AzureStorageContainer": "$web",
        "AzureStorageTargetDirectory": "MySite/UAT"
    }
}]

Important Note About Folders in Azure Blob Storage

Azure Blob Storage doesn't have a real concept of "folders", but it can be made to behave similar to the way you would expect it to if it did have folders, so long as you use a forward slash (/) as the delimiter of your path slugs. For example, in the above, the value "MySite/UAT" will effectively function as though the /UAT folder is a subdirectory of /MySite.

Calling the Azure Blob Storage Deploy Handler Data from the Middleman

This section describes how you can call the Azure Blob Storage Deploy Handler from the default RabbitMQ Middleman as well the provided TeamCity Meta-Runner.

  1. {"CompletionHandlers":[{"ID":"Azure_ABS","Params":{"AzureStorageAccountConnectionString":"DefaultEndpointsProtocol=https;AccountName=sitecoredxg;AccountKey=MY_ACCOUNT_KEY;EndpointSuffix=core.windows.net","AzureStorageContainer":"$web","AzureStorageTargetDirectory":"MySite/UAT"}}]}

In order to pass this object to the handler, it should be passed in as the Params object of the completion handler data in stored in the JSON file at the . The following illustrates the completion handler data object for the Azure Blob Storage Deploy Completion Handler within the completion handler data array:

Complete the steps described in the section, above, on your SitecoreDXG Generation Server

Create your completion handler data object for the Azure Blob Storage Deploy Handler, as described above in the section, for example:

Save the JSON object to your

Pass the to the middleman so that it can be passed to the Trigger and subsequently to the Generator

If using the default RabbitMQ middleman: see for more information on the middleman parameters and syntax

If using the provided TeamCity Meta-Runner: see for more information on the fields and syntax

Static Website Hosting
technical preview
Azure portal
Getting Started
OPTIONS_FILE_PATH
OPTIONS_FILE_PATH
OPTIONS_FILE_PATH
Using the Default RabbitMQ Middleman and Trigger
Integrating the Default TeamCity RabbitMQ Meta-Runner
Setup
Parameters