Configuration parameters

You can deploy HCL People Service using the HCL Digital Experience (DX) Helm chart as it is included as a dependency in the form of a sub chart. The parameters below will help you configure People Service depending on your needs.

Image configuration

Key	Type	Default	Description
image.pullPolicy	enum	IfNotPresent	People Service image pull policy. Accepted values are Always, Never, and IfNotPresent
image.imagePullSecrets	array	[]	People Service image pull secrets used for accessing the image registry
image.registry	string	quintana-docker.artifactory.cwp.pnp-hcl.com	People Service container image registry
image.repository	string	dx-build-output/people-service/people-service	People Service container image repository
image.tag	string	latest	People Service container image tag

Application configuration

Key	Type	Default	Description
configuration.production	boolean	true	Specifies whether you are running in production mode or not
configuration.authStrategy	string	none	Authentication strategy. Accepted values are OIDC, DX, and none
configuration.uniqueUserIdentifier	string	guid	Identifier that uniquely distinguishes a user
configuration.integration.dx	boolean	false	Indicates if DX integration is enabled
configuration.jwt.tokenExpiration	int	3600000	JWT token expiration time in milliseconds
configuration.jwt.secret	string	``	JWT secret
configuration.jwt.existingSecret	string	``	Existing secret for JWT secret
configuration.jwt.existingSecretJwtSecretKey	string	``	Existing secret key for jwtSecret, if not specified, defaults to "jwtSecret"
extraEnvVars	array	[]	Additional environment variables for the container

OIDC configuration

Key	Type	Default	Description
configuration.oidc.issuer	string	``	Issuer url
configuration.oidc.clientId	string	``	Client ID
configuration.oidc.clientSecret	string	``	Client secret
configuration.oidc.redirectURI	string	``	Redirect uri
configuration.oidc.scopes	string	openid profile email	OIDC scopes
configuration.oidc.existingSecret	string	``	Existing secret for OIDC configuration
configuration.oidc.existingSecretClientSecretKey	string	``	Existing secret key for clientSecret. Defaults to clientSecret if not specified

DX configuration

Key	Type	Default	Description
configuration.dx.sessionCookieName	string	JSESSIONID	Session cookie name
configuration.dx.userValidationEndpoint	string	/auth/validate	User validation endpoint that confirms if the user is still authenticated
configuration.dx.currentUserAccessEndpoint	string	/dxmyrest/access/current-user?resourceId=wps.USERS	Current user access endpoint that identifies the current user's access level information. This information is used to determine the user's role. Accepted values are Privileged, Authenticated, or Unauthenticated
configuration.dx.userAccessPrivilegedRoles	string	Administrator,Privileged User,Editor	List of privileged roles separated by commas
configuration.dx.cacheTTL	int	3600000	Cache time to live for current user access endpoints response in milliseconds
configuration.dx.cacheMaxEntries	int	1000	Maximum number of entries in the cache that stores the user's role
configuration.dx.portletPageContextRoot	string	/wps/myportal/Practitioner/PeopleService	Context root for the People Service portlet page

Schema configuration

Key	Type	Default	Description
configuration.schema.readonlyFields	array	["id","firstName","lastName","displayName","organization","email","dn","managerId"]	List of profile fields that should be marked as read-only
configuration.schema.customFields	array	[]	List of custom fields that need to be created while deployment

Networking configuration

Key	Type	Default	Description
networking.ssl.enabled	boolean	false	Indicates if the application is accessible on http or https
networking.host	string	``	Public qualified host name. For example: "example.com". If networking.ssl.enabled is true, this key will be prefixed with https://, and http:// if false
networking.contextRoot.api	string	/people/api/v1	Context root for the API
networking.contextRoot.ui	string	/people/ui	Context root for the UI
networking.ingress.enabled	boolean	false	Enable ingress for the application
networking.ingress.ingressClassName	string	``	Class name for the ingress
networking.ingress.pathType	string	Prefix	Path type for the ingress
networking.ingress.autoGenerateSelfSignedCert	boolean	false	Enable auto generation of self-signed certificate for the ingress
networking.ingress.existingSecret	string	``	Existing secret for TLS certificate
networking.ingress.annotations	object	{"nginx.ingress.kubernetes.io/proxy-body-size":"50m"}	Annotations for Ingress route

LDAP configuration

Key	Type	Default	Description
ldap.enabled	boolean	false	Indicates if LDAP is enabled. If set to true, ensure that the values for required parameter ldap.host is provided
ldap.host	string	``	LDAP server URL
ldap.bindDn	string	cn=admin,dc=dx,dc=com	LDAP Bind dn
ldap.bindPassword	string	password	LDAP Bind password
ldap.searchBase	string	ou=users,dc=dx,dc=com	LDAP search base
ldap.searchFilterAllUsers	string	(objectClass=inetOrgPerson)	LDAP search filter for all users
ldap.searchFilterUser	string	(&(objectClass=inetOrgPerson)(uid=*))	LDAP search filter for a specific user
ldap.searchScope	string	sub	LDAP search scope. Accepted values are base, one, and sub
ldap.searchAttributes	array	["dn","uid","givenName","sn","mail","manager","ou","displayName","telephoneNumber","street","l","st","postalCode","preferredLanguage","title","description","jpegPhoto"]	LDAP search attributes
ldap.userImageAttribute	string	jpegPhoto	LDAP user image attribute
ldap.attributeMapping	object	{"city":"l","displayName":"displayName","dn":"dn","email":"mail","firstName":"givenName","guid":"uid","language":"preferredLanguage","lastName":"sn","managerId":"manager","organization":"ou","phone":"telephoneNumber","professionalSummary":"description","role":"title","state":"st","streetAddress":"street","zipCode":"postalCode"}	LDAP attribute mapping
ldap.existingSecret	string	``	Existing secret for LDAP configuration
ldap.existingSecretBindPasswordKey	string	``	Existing secret key for bindPassword. Defaults to bindPassword if not specified

User synchronization configuration

Key	Type	Default	Description
userSynchronization.enabled	boolean	false	Indicates if user synchronization is enabled
userSynchronization.strategy	string	sync	User synchronization strategy. Accepted values are sync and none
userSynchronization.cronSchedule	string	0 */4 * * *	Cron schedule for user synchronization
userSynchronization.preventConcurrentExecution	boolean	true	Indicates if user synchronization is run in mutual exlusive mode

External database configuration

Key	Type	Default	Description
externalDatabase.host	string	``	PostgreSQL host
externalDatabase.port	int	5432	PostgreSQL port
externalDatabase.user	string	``	PostgreSQL user
externalDatabase.database	string	``	PostgreSQL database
externalDatabase.password	string	``	PostgreSQL password
externalDatabase.existingSecret	string	``	Existing secret for external PostgreSQL configuration
externalDatabase.existingSecretUserKey	string	``	Existing secret key for user. Defaults to db-user if not specified
externalDatabase.existingSecretPasswordKey	string	``	Existing secret key for password. Defaults to "db-password" if not specified

Container ports configuration

Key	Type	Default	Description
containerPorts.http	int	3000	Port exposed by the container for HTTP traffic

Service configuration

Key	Type	Default	Description
service.type	string	ClusterIP	Service type. Accepted values are ClusterIP, NodePort, and LoadBalancer
service.ports.http	int	3000	Port exposed by the service for HTTP traffic
service.ports.nodePort	int	30000	Port exposed by the service when service.type is set to NodePort

Node configuration

Key	Type	Default	Description
nodeSelector	object	{}	Node labels for pod assignment. Evaluated as a template

Logging configuration

Key	Type	Default	Description
logging.level	string	DEBUG:people-service:*	Log level for the application
logging.path	string	/data/people/logs	Log path for the application
logging.sidecar.maintenanceModeEnabled	string	false	Enable or disable maintenance mode for the sidecar
logging.sidecar.audit	object	{"enabled":false}	Configuration for the audit logging
logging.sidecar.audit.enabled	boolean	false	Enable or disable audit logging
logging.sidecar.sync	object	{"enabled":false}	Configuration for the sync logging
logging.sidecar.sync.enabled	boolean	false	Enable or disable sync logging
logging.sidecar.image.pullPolicy	enum	IfNotPresent	Logging sidecar image pull policy. Accepted values are Always, Never, and IfNotPresent
logging.sidecar.image.registry	string	quintana-docker.artifactory.cwp.pnp-hcl.com	Logging sidecar container image registry
logging.sidecar.image.repository	string	dx-build-output/common/logging-sidecar	Logging sidecar container image repository
logging.sidecar.image.tag	string	v1.0.0_20240506-1523_pjs_develop	Logging sidecar container image tag

Resource configuration

Key	Type	Default	Description
resources.requests.cpu	string	250m	CPU request for the pod
resources.requests.memory	string	256Mi	Memory request for the pod
resources.limits.cpu	string	1000m	CPU limit for the pod
resources.limits.memory	string	1024Mi	Memory limit for the pod

Labels and Annotations configuration

Key	Type	Default	Description
annotations.service	array	nil	Service annotations
annotations.pod	array	nil	Pod annotations
labels.service	array	nil	Service labels
labels.pod	array	nil	Pod labels

Scaling configuration

Key	Type	Default	Description
scaling.replicaCount	int	1	The default number of replicas for the pod
scaling.horizontalPodAutoScaler.enabled	boolean	false	Enable autoscaling for People Service deployment
scaling.horizontalPodAutoScaler.minReplicas	number	1	Minimum number of replicas to scale back
scaling.horizontalPodAutoScaler.maxReplicas	number	3	Maximum number of replicas to scale out
scaling.horizontalPodAutoScaler.targetCPUUtilizationPercentage	number	75	Target CPU utilization percentage
scaling.horizontalPodAutoScaler.targetMemoryUtilizationPercentage	number	80	Target Memory utilization percentage

Persistence Volume configuration

Key	Type	Default	Description
volumes.data.storageClassName	string	manual	PVC Storage Class for People Service data volume
volumes.data.requests.storage	string	1Gi	PVC Storage Request for People Service data volume
volumes.data.selector	object	{}	Selector to match an existing Persistent Volume. This value is evaluated as a template
volumes.data.volumeName	string	``	Name of the volume to bind to the PVC
volumes.customPVCs	object	[]	List of optional additional PVCs for customer applications. Each list element must include a unique name, one or more accessModes from the options ReadWriteOnce, ReadOnlyMany or ReadWriteMany, a mountPath specifying where in the core container it should be mounted, a storageClassName and a size in requests/storage. It may also optionally include a selector section to select specific PVs based on their labels. It may also optionally include a volumeName to select a specific PV

Probes configuration

Key	Type	Default	Description
probes.livenessProbe.enabled	boolean	true	Enable liveness probe on containers
probes.livenessProbe.failureThreshold	int	10	Number of times the probe should be retried before marking the container as unhealthy
probes.livenessProbe.initialDelaySeconds	int	30	Number of seconds after the container has started before liveness probes are initiated
probes.livenessProbe.periodSeconds	int	30	How often the probe is performed. Measured in seconds
probes.livenessProbe.successThreshold	int	1	Minimum consecutive successes for the probe to be considered successful after failing
probes.livenessProbe.timeoutSeconds	int	15	Number of seconds before the probe times out
probes.readinessProbe.enabled	boolean	true	Enable readiness probe on containers
probes.readinessProbe.failureThreshold	number	3	Number of times the probe should be retried before marking the container as unhealthy
probes.readinessProbe.initialDelaySeconds	number	30	Number of seconds after the container has started before readiness probes are initiated
probes.readinessProbe.periodSeconds	number	15	How often the probe is performed. Measured in seconds
probes.readinessProbe.successThreshold	number	1	Minimum consecutive successes for the probe to be considered successful after failing
probes.readinessProbe.timeoutSeconds	number	10	Number of seconds before the probe times out