How to Configure the Hybrid Deployment Agent for OpenShift?

Question

How do I configure the Hybrid Deployment Agent to run on OpenShift?

Environment

Container platform: Kubernetes (OpenShift)

Answer

OpenShift is built on Kubernetes and follows the same deployment requirements as any Kubernetes-based environment. Before you configure the Hybrid Deployment Agent, make sure you meet the following prerequisites:

• Helm requirements: You must use Helm to deploy and manage the Hybrid Deployment Agent.
• System requirements: See the Kubernetes system requirements.
• Storage requirements (PV/PVC): Ensure your OpenShift cluster provides the required persistent storage. For more information, see the storage requirements.
• Network requirements: Confirm your cluster meets the network requirements.

To configure the Hybrid Deployment Agent for OpenShift, you must set the agent's profile parameter to openshift during deployment. You can set the configuration parameter by adding it to your values.yaml file or by specifying it directly in your Helm command.

Specify profile in values.yaml file

Add profile: openshift under the config section of your Helm values.yaml file:

config:
  namespace: YOUR_NAMESPACE_HERE
  data_volume_pvc: YOUR_PERSISTENT_VOLUME_CLAIM_HERE
  token: YOUR_TOKEN_HERE
  profile: openshift

We recommend this method if you manage your settings through version-controlled configuration files or need consistent deployments across environments.

Specify profile in Helm command

Specify the profile using the --set flag when installing or upgrading the agent:

helm upgrade --install hd-agent \
  oci://us-docker.pkg.dev/prod-eng-fivetran-ldp/public-docker-us/helm/hybrid-deployment-agent \
  --create-namespace \
  --namespace default \
  --set config.data_volume_pvc=YOUR_PERSISTENT_VOLUME_CLAIM_HERE \
  --set config.token="YOUR_TOKEN_HERE" \
  --set config.namespace=default \
  --set config.profile=openshift \
  --version