Walkthrough: Adding the SCCH connector module to Sitecore in Azure Kubernetes Service
You can add the Sitecore Connect for Content Hub (SCCH) connector to a Sitecore container environment in Azure Kubernetes Service (AKS).
This walkthrough describes how to:
-
Build the SCCH images and push them to Azure
-
Prepare files and folders for deployment
-
Deploy the containers using kubectl commands
Build the SCCH images and push them to Azure
To build the images for SCCH and push them to Azure:
-
Build the images for SCCH as explained in Add the SCCH connector module to Sitecore in Docker.
-
Open the Windows console and use the
docker tagcommand to tag the images. For example:RequestResponsedocker tag sitecore-chub-xp1-cm:<tag version> $registry/sitecore-chub-xp1-cm:<tag version> -
In the console, use the
docker pushcommand to push the images to your Azure registry. For example:RequestResponsedocker push $registry/sitecore-chub-xp1-cm:<tag version>
Prepare files and folders for deployment
To prepare files and folders in your installation for deployment:
-
In the folder where you extracted the SCCH container deployment package, navigate to the
SCCH\<Sitecore version>\k8s\<windows version>folder, for example,SCCH\k8s\ltsc2019. Copy theoverridessubfolder to the Sitecore Experience Platform (SXP) container deployment package folderk8s\<version>(on the same level as thexp1folder). -
If you are deploying to Sitecore 10.1.3 on Kubernetes, in the
k8s\<version>\overrides\<topology>folder, create a subfolder and name itinit. In theinitsubfolder, create a file, name itkustomization.yaml, and add the following instructions to it:RequestResponseapiVersion: kustomize.config.k8s.io/v1beta1 kind: Kustomization bases: - ../../../<topology>/init images: - name: scr.sitecore.com/sxp/sitecore-<topology>-mssql-init newName: "{registry}/sitecore-chub-<topology>-mssql-init" newTag: tag -
In the
overrides\<topology>\secretsfolder, update each of the following files with connection string details:-
sitecore-cmp-content-hub.txt -
sitecore-cmp-service-bus-entity-path-in.txt -
sitecore-cmp-service-bus-entity-path-out.txt -
sitecore-cmp-service-bus-subscription.txt -
sitecore-dam-content-hub.txt -
sitecore-dam-external-redirect-key.txt -
sitecore-dam-search-page.txt
NoteEach file contains an example of how the connection string looks.
-
Deploy the containers
Before you can deploy the containers using kubectl commands, you must 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
k8s\<version>folder. -
Deploy the secrets. Use this command:
RequestResponsekubectl apply -k ./overrides/<topology>/secrets/ -
Run the
externalfolder. Use this command:RequestResponsekubectl apply -k ./<topology>/external/ -
Wait for all containers to have the status Ok/Running. You can check the status with this command:
RequestResponsekubectl get pods -o wide -
Run the
initfolder:-
If you are deploying to Sitecore 10.1.3, use this command:
RequestResponsekubectl apply -k ./overrides/<topology>/init/ -
If you are deploying to any other Sitecore version, use this command:
RequestResponsekubectl apply -k ./<topology>/init/
-
-
Wait for all containers to have the status Completed. You can check the status with this command:
RequestResponsekubectl get pods -
If you are using the
XP1topology, and you want to create persistent volumes, run this command:RequestResponsekubectl apply -f ./xp1/volumes/azurefileNotePersistent volumes are only available for the
XP1topology -
Run the Sitecore containers with the SCCH changes. Use this command:
RequestResponsekubectl apply -k ./overrides/<topology>/ -
Wait for all containers to have the status Ok/Running. You can check the status with the
kubectl get podscommand. -
To enable external access, you must update the local host file with the external IP address. To obtain the external IP address, use this command:
RequestResponsekubectl get service -l app=nginx-ingressNoteFor information on how to update the local host file, 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.
-
To enable the DAM functionality, configure a connection to Sitecore DAM.