Walkthrough: Adding the SFCRM connector module to Sitecore in Azure Kubernetes Service

Abstract

How to install the Sitecore Connect for Salesforce CRM connector on an Azure Kubernetes Service container environment.

You can add the Sitecore Connect for Salesforce CRM (SFCRM) connector to a Sitecore container environment in Azure Kubernetes Service (AKS).

This walkthrough describes how to:

  • Build the SFCRM images and push them to Azure.

  • Prepare files and folders for deployment.

  • Deploy the containers using kubectl commands.

  • Update your search indexes.

To build the images for SFCRM and push them to Azure:

  1. Build the images for SFCRM as explained in Walkthrough: Preparing to install the SFCRM connector in a container environment.

    Note

    The Kubernetes deployment requires an mssql-init image. You must ensure that you include mssql-init in your docker-compose-override.yml file.

  2. Open the Windows console, and use the docker tag command to tag the images. For example:

    docker tag sitecore-sfcrm-xp1-cm:10.1.0.005207.643-10.0.17763.1757-ltsc2019 $registry/sitecore-sfcrm-xp1-cm:<tag version>
  3. In the console, use the docker push command to push the images to your Azure registry. For example:

    docker push $registry/sitecore-sfcrm-xp1-cm:<tag version>

To prepare files and folders in your installation for deployment:

  1. Download the Sitecore SFCRM container deployment package from the Sitecore download page and extract it to a folder on your local workstation.

  2. Open the folder that you extracted the Sitecore SFCRM container deployment package to.

  3. Navigate to the k8s\<version>\<topology> folder, for example, k8s\ltsc2019\xp1. Copy the overrides subfolder to the Sitecore Experience Platform (SXP) container deployment package folder k8s\<version> (on the same level as the xp1 folder).

  4. In the SXP container deployment package, in each of the overrides, overrides\xp1\init, and overrides\xp1\secrets folders, locate the kustomization.yaml file. In each file, update the bases parameter with the appropriate folder names for your installation, for example, ../../xp1.

    Note

    The bases parameter contains the placement of the original Sitecore container deployment files that the kustomization.yaml files override.

  5. In each of the kustomization.yaml files, in the images: section, update the newName and newTag parameters with the values for the mssql-init, cm, xdbcollection, xdbsearch and xdbsearchworker images you pushed to the Azure Registry.

  6. In the overrides\xp1\secrets folder, in the sitecore-salesforce-crm-connection-string.txt file , replace the content with the connection string you prepared in ???.

To deploy the containers and the necessary Kubernetes components:

  1. 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.

  2. Open the Windows console, and navigate to the folder containing the xp1 and overrides folders.

  3. Deploy the secrets. Use this command:

    kubectl apply -k ./overrides/xp1/secrets/
  4. Run the external folder. Use this command:

    kubectl apply -k ./xp1/external/
  5. Wait for all containers to have the status Ok/Running. You can check the status with this command:

    kubectl get pods -o wide
  6. Run the init folder. Use this command:

    kubectl apply -k ./overrides/xp1/init/
  7. Wait for all containers to have the status Completed. You can check the status with this command:

    kubectl get pods
  8. To create persistent volumes, run this command:

    kubectl apply -f ./xp1/volumes/azurefile
  9. Run the Sitecore containers with the SFCRM changes. Use this command:

    kubectl apply -k ./overrides/xp1/
  10. Wait for all containers to have the status Ok/Running. You can check the status with the kubectl get pods command.

  11. 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.

  12. Update your search indexes.