Walkthrough: Adding the DCRM connector module to Sitecore in Azure Kubernetes Service
You can add the Sitecore Connect for Microsoft Dynamics 365 for Sales (DCRM) connector in Azure Kubernetes Service (AKS).
This walkthrough describes how to:
-
Build the DCRM images and push them to Azure.
-
Prepare files and folders for deployment.
-
Deploy the containers using kubectl commands.
-
Update your Solr indexes.
Build images and push them to Azure
To build the images for DCRM and push them to Azure:
-
Build the images for DCRM as explained in Walkthrough: Preparing to install the DCRM connector in a container environment.
-
Open the Windows console, and use the
docker tag
command to tag the images. For example:RequestResponseshelldocker tag sitecore-dcrm-xp1-cm:7.0.0-1497 $registry/experimental/sitecore-dcrm-xp1-cm:sc102
-
In the console, use the
docker push
command to push the images to your Azure registry. For example:RequestResponseshelldocker push $registry/sitecore-dcrm-xp1-cm:sc102
Prepare files and folders for deployment
To prepare files and folders in your installation for deployment:
-
Download the Sitecore DCRM container deployment package from the Sitecore download page and extract it to a folder on your local workstation.
-
Open the folder that you extracted the Sitecore DCRM container deployment package to.
-
Navigate to the
dcrm\k8s\<version>
folder, for example,dcrm\k8s\ltsc2019
. Copy theoverrides
subfolder to the Sitecore Experience Platform (SXP) container deployment package folderk8s\<version>
(on the same level as the xp1 folder). -
In the SXP container deployment package, in each of the
overrides\<topology>
,overrides\<topology>\init
, andoverrides\<topology>\secrets
folders, locate thekustomization.yaml
file. In each file, update thebases
parameter with the appropriate folder names for your installation, for example,../../xp1
.NoteThe
bases
parameter contains the placement of the original Sitecore container deployment files that thekustomization.yaml
files override. -
In each of the
kustomization.yaml
files, in theimages:
section, update thenewName
andnewTag
parameters with the values for the images you pushed to the Azure Registry, for example,mssql-init
,cm
,xdbcollection
,xdbsearch
, andxdbsearchworker
.NoteTo find the values you need for, for example, the
mssql-init
image, go to the Azure Container Registry, search for yoursitecore-dcrm-xp1-mssql-init
image, and take the values from that image. -
In the
overrides\xp1\secrets
folder, in thesitecore-data-exchange-staging.txt
andsitecore-dcrm.txt
files , update the connection string details.NoteThe files contain an example of how the connection string must look.
Deploy the containers
Prepare the AKS cluster configuration and deploy the ingress controller. For information on how to do this, see the Installation Guide for Production Environment for Kubernetes which is available on the Sitecore download page.
To deploy the containers and the necessary Kubernetes components:
-
Open the Windows console, and navigate to the folder containing the
xp1
andoverrides
folders. -
Deploy the secrets. Use this command:
RequestResponseshellkubectl apply -k ./overrides/<topology>/secrets/
-
Run the
external
folder. Use this command:RequestResponseshellkubectl apply -k ./<topology>/external/
-
Wait for all containers to have the status Ok/Running. You can check the status with this command:
RequestResponseshellkubectl get pods -o wide
-
Run the
init
folder. Use this command:RequestResponseshellkubectl apply -k ./overrides/<topology>/init/
-
Wait for all containers to have the status Completed. You can check the status with this command:
RequestResponseshellkubectl get pods
-
To create persistent volumes, run this command:
RequestResponseshellkubectl apply -f ./xp1/volumes/azurefile
-
Run the Sitecore containers with the DCRM changes. Use this command:
RequestResponseshellkubectl apply -k ./overrides/<topology>/
-
Wait for all containers to have the status Ok/Running. You can check the status with the
kubectl get pods
command. -
Update the local host file. For information on how to do this, see the Installation Guide for Production Environment for Kubernetes, which is available on the Sitecore download page.
When the containers have been deployed, rebuild your search indexes.