Deploying ACS + Knowledge Retrieval

This guide demonstrates how to deploy connector for Knowledge Retirieval using the Alfresco ACS Deployment repository.

Prerequisites

Ensure you have the following:

• Helm installed on your system.
• Kubernetes cluster configured and running.

Steps to Deploy

Create a Secret

Create env file with credentials. Customize the values as needed for your setup.

HX_CLIENT_ID=sc-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
HX_CLIENT_SECRET=yoursecret
HX_ENV_KEY=alfresco-kd-ci-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
HX_APP_SOURCE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx

Create a Kubernetes secret containing the credentials for Knowledge Retrieval instance

kubectl create secret generic hxi-secrets \
    --namespace=default \
    --from-env-file=hxi.env

Ingress

See ingress-nginx section.

ACS Chart

See desktop-deployment section.

Enterprise local values

Download local-dev_values.yaml file as described in desktop-deployment section.

Understand the Patch File

The hxi.yml patch file defines the configuration for the Knowledge Retrieval. It includes settings for secrets and URLs required by both the repository and the live ingester instances.

curl -fO https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/values/hxi.yml

Deploy the Infrastructure

Deploy the ACS stack with the appropriate values files.

:warning: This example adds the HXI extension to the repository using an init container.
However, a more recommended approach is to bake the extension directly into the image.
For guidance, see our alfresco-dockerfiles-bakery repository — especially the simple_modules section.

helm install acs alfresco/alfresco-content-services \
    --set global.known_urls=http://localhost \
    --set global.alfrescoRegistryPullSecrets=quay-registry-secret \
    --values local-dev_values.yaml \
    --values hxi.yaml