TFO Helm Chart Configuration Value Guide (v16.1.0 or newer)

Modified on Fri, Jun 26 at 5:06 PM

Note:This file is continuously updated. Therefore, there may be differences between the version at the time of writing (v16.1.0) and when you are reading this.

This document introduces a guide to setting up ThinkfreeOffice HelmChart.

HelmChart allows clients to modify container environments in various ways through configuration files. If you haven’t yet downloaded the configuration files, please refer to the install Thinkfree Office guide.

Download the Configuration File

1. Set variable values

ACCOUNT=958750823146
REGION=ap-northeast-2
TOKEN=`aws ecr get-login-password --region=${REGION}`

2. AWS Authentication

helm registry login --username AWS --password-stdin ${ACCOUNT}.dkr.ecr.${REGION}.amazonaws.com <<< "${TOKEN}"

3. Download Settings File

helm show values oci://${ACCOUNT}.dkr.ecr.${REGION}.amazonaws.com/thinkfree-office-chart > values.yaml

Now you are ready to edit the downloaded values.yaml file using a text editor such as VI.

Setting Value Guide

Key	Type	Default	Description
nameOverride	string	nil	Rename HelmChart.
fullnameOverride	string	nil	Change the Application name. If not entered separately, it uses the Release name set during the HelmChart installation process. For reference, the name for each container is determined according to the following method. If fullnameOverride is defined, it follows that name. If Option 1 is not provided, follow the appName attribute of each container. If no alternative is provided, follow the default defined name for each container.
namespaceOverride	string	nil	Changes the namespace where HelmChart is installed. If not entered separately, it follows the namespace where HelmChart is installed.
global.replicaCount	int	1	This is the default number of Pods. You can override replicaCount for each container. (e.g., `was.replicaCount: 2`) # Note: The broker supports only 1 (Active only) or 2 (Active/StandBy).
global.image.registry	string	“958750823146.dkr.ecr.ap-northeast-2.amazonaws.com”	Enter the container image registry address.
global.image.tag	string	“16.1.0”	Enter the container image tag. If not entered separately, it follows the appVersion value in Chart.yaml.
global.image.pullPolicy	string	“IfNotPresent”	Enter the container image pull policy.
global.image.pullSecrets	list	[]	Enter the Secret name for the container image pull.
serviceAccount.create	bool	true	Set whether to use ServiceAccount.
serviceAccount.annotations	object	{}	Set the ServiceAccount annotations property.
serviceAccount.automountServiceAccountToken	bool	true	Set the ServiceAccount automountServiceAccountToken property.
rbac.enabled	bool	true	Configures Kubernetes Role-Based Access Control (RBAC). It is used for Kubernetes authentication during Hazelcast clustering. Change this to false only in environments where Kubernetes authentication cannot be handled. If you change it to false, operation is guaranteed only in environments where the Pod is configured to run on a single instance.
was.service.port	int	80	Change the port of the container to be deployed.
was.service.annotations	object	{}	Sets the Service annotations property.
was.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located.
was.tolerations	list	[]	Sets the container's tolerations property.
was.affinity	object	{}	Sets the container's affinity property.
was.podAnnotations	object	{}	Sets the container's podAnnotations property.
was.readinessProbe.enabled	bool	true	Sets whether to use ReadinessProbe.
was.readinessProbe.initialDelaySeconds	int	30	Sets the initialDelaySeconds property of ReadinessProbe.
was.readinessProbe.periodSeconds	int	10	Sets the periodSeconds property of the ReadinessProbe.
was.readinessProbe.timeoutSeconds	int	5	Sets the timeoutSeconds property of ReadinessProbe.
was.readinessProbe.successThreshold	int	1	Sets the successThreshold property of the ReadinessProbe.
was.readinessProbe.failureThreshold	int	5	Sets the failureThreshold property of the ReadinessProbe.
was.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe.
was.livenessProbe.initialDelaySeconds	int	60	Sets the initialDelaySeconds property of LivenessProbe.
was.livenessProbe.periodSeconds	int	10	Sets the periodSeconds property of LivenessProbe.
was.livenessProbe.timeoutSeconds	int	5	Sets the timeoutSeconds property of LivenessProbe.
was.livenessProbe.successThreshold	int	1	Sets the successThreshold property of LivenessProbe.
was.livenessProbe.failureThreshold	int	5	Sets the failureThreshold property of LivenessProbe.
was.resources	object	{}	Limit resources per container.
was.autoscaling.enabled	bool	true	Sets whether to use HPA (Horizontal Pod Autoscaler).
was.autoscaling.minReplicas	int	1	Sets the minReplicas property of HPA (Horizontal Pod Autoscaler).
was.autoscaling.maxReplicas	int	3	Sets the maxReplicas property of HPA (Horizontal Pod Autoscaler).
was.autoscaling.targetCPU	string	“50”	Sets the targetCPU property of HPA (Horizontal Pod Autoscaler).
was.autoscaling.targetMemory	string	“80”	Sets the targetMemory property of HPA (Horizontal Pod Autoscaler).
was.ingress.enabled	bool	false	Sets whether to use Ingress.
was.ingress.annotations	object	{}	Sets the annotations property of the Ingress.
was.ingress.hosts	list	[]	Sets the hosts property of Ingress.
was.ingress.paths	list	[]	Sets the paths property of the Ingress.
was.ingress.pathType	string	nil	Sets the pathType property of the Ingress.
was.ingress.tls	list	[]	Set the Ingress's tls properties.
was.ingress.ingressClassName	string	nil	Sets the name of the IngressClass.
broker.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located.
broker.tolerations	list	[]	Sets the container's tolerations property.
broker.affinity	object	{}	Sets the container's affinity property.
broker.podAnnotations	object	{}	Sets the container's podAnnotations property.
broker.resources	object	{}	Limit resources per container.
broker.extraEnv	list	[]	Set environment variables to add or change when running the container.
filter.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located.
filter.tolerations	list	[]	Sets the container's tolerations property.
filter.affinity	object	{}	Sets the container's affinity property.
filter.podAnnotations	object	{}	Sets the container's podAnnotations property.
filter.resources	object	{}	Limit resources per container.
filter.autoscaling.enabled	bool	true	Sets whether to use HPA (Horizontal Pod Autoscaler).
filter.autoscaling.minReplicas	int	1	Sets the minReplicas property of HPA (Horizontal Pod Autoscaler).
filter.autoscaling.maxReplicas	int	3	Sets the maxReplicas property of HPA (Horizontal Pod Autoscaler).
filter.autoscaling.targetCPU	string	“50”	Sets the targetCPU property of HPA (Horizontal Pod Autoscaler).
filter.autoscaling.targetMemory	string	“80”	Sets the targetMemory property of HPA (Horizontal Pod Autoscaler).
filter.extraVolumes	list	[]	Set the definition for additional volumes in the Pod.
filter.extraVolumeMounts	list	[]	Set up definitions for additional volume mounts on the Pod.
filter.extraEnv	list	[]	Set environment variables to add or change when running the container.
document.word.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located.
document.word.tolerations	list	[]	Sets the container's tolerations property.
document.word.affinity	object	{}	Sets the container's affinity property.
document.word.podAnnotations	object	{}	Sets the container's podAnnotations property.
document.word.readinessProbe.enabled	bool	true	Sets whether to use ReadinessProbe.
document.word.readinessProbe.initialDelaySeconds	int	20	Sets the initialDelaySeconds property of ReadinessProbe.
document.word.readinessProbe.periodSeconds	int	10	Sets the periodSeconds property of the ReadinessProbe.
document.word.readinessProbe.timeoutSeconds	int	5	Sets the timeoutSeconds property of ReadinessProbe.
document.word.readinessProbe.successThreshold	int	1	Sets the successThreshold property of the ReadinessProbe.
document.word.readinessProbe.failureThreshold	int	5	Sets the failureThreshold property of the ReadinessProbe.
document.word.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe.
document.word.livenessProbe.initialDelaySeconds	int	60	Sets the initialDelaySeconds property of LivenessProbe.
document.word.livenessProbe.periodSeconds	int	10	Sets the periodSeconds property of LivenessProbe.
document.word.livenessProbe.timeoutSeconds	int	5	Sets the timeoutSeconds property of LivenessProbe.
document.word.livenessProbe.successThreshold	int	1	Sets the successThreshold property of LivenessProbe.
document.word.livenessProbe.failureThreshold	int	5	Sets the failureThreshold property of LivenessProbe.
document.word.resources	object	{}	Limit resources per container.
document.word.autoscaling.enabled	bool	true	Sets whether to use HPA (Horizontal Pod Autoscaler).
document.word.autoscaling.minReplicas	int	1	Sets the minReplicas property of HPA (Horizontal Pod Autoscaler).
document.word.autoscaling.maxReplicas	int	3	Sets the maxReplicas property of HPA (Horizontal Pod Autoscaler).
document.word.autoscaling.targetCPU	string	“50”	Sets the targetCPU property of HPA (Horizontal Pod Autoscaler).
document.word.autoscaling.targetMemory	string	“80”	Sets the targetMemory property of HPA (Horizontal Pod Autoscaler).
document.word.extraEnv	list	[]	Set environment variables to add or change when running the container.
document.show.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located.
document.show.tolerations	list	[]	Sets the container's tolerations property.
document.show.affinity	object	{}	Sets the container's affinity property.
document.show.podAnnotations	object	{}	Sets the container's podAnnotations property.
document.show.readinessProbe.enabled	bool	true	Sets whether to use ReadinessProbe.
document.show.readinessProbe.initialDelaySeconds	int	20	Sets the initialDelaySeconds property of ReadinessProbe.
document.show.readinessProbe.periodSeconds	int	10	Sets the periodSeconds property of the ReadinessProbe.
document.show.readinessProbe.timeoutSeconds	int	5	Sets the timeoutSeconds property of ReadinessProbe.
document.show.readinessProbe.successThreshold	int	1	Sets the successThreshold property of the ReadinessProbe.
document.show.readinessProbe.failureThreshold	int	5	Sets the failureThreshold property of the ReadinessProbe.
document.show.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe.
document.show.livenessProbe.initialDelaySeconds	int	60	Sets the initialDelaySeconds property of LivenessProbe.
document.show.livenessProbe.periodSeconds	int	10	Sets the periodSeconds property of LivenessProbe.
document.show.livenessProbe.timeoutSeconds	int	5	Sets the timeoutSeconds property of LivenessProbe.
document.show.livenessProbe.successThreshold	int	1	Sets the successThreshold property of LivenessProbe.
document.show.livenessProbe.failureThreshold	int	5	Sets the failureThreshold property of LivenessProbe.
document.show.resources	object	{}	Limit resources per container.
document.show.autoscaling.enabled	bool	true	Sets whether to use HPA (Horizontal Pod Autoscaler).
document.show.autoscaling.minReplicas	int	1	Sets the minReplicas property of HPA (Horizontal Pod Autoscaler).
document.show.autoscaling.maxReplicas	int	3	Sets the maxReplicas property of HPA (Horizontal Pod Autoscaler).
document.show.autoscaling.targetCPU	string	“50”	Sets the targetCPU property of HPA (Horizontal Pod Autoscaler).
document.show.autoscaling.targetMemory	string	“80”	Sets the targetMemory property of HPA (Horizontal Pod Autoscaler).
document.show.extraEnv	list	[]	Set environment variables to add or change when running the container.
redis.service.port	int	6379	Change the port of the container to be deployed.
redis.service.annotations	object	{}	Sets the Service annotations property.
redis.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located.
redis.tolerations	list	[]	Sets the container's tolerations property.
redis.affinity	object	{}	Sets the container's affinity property.
redis.podAnnotations	object	{}	Sets the container's podAnnotations property.
redis.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe.
redis.livenessProbe.initialDelaySeconds	int	60	Sets the initialDelaySeconds property of LivenessProbe.
redis.livenessProbe.periodSeconds	int	10	Sets the periodSeconds property of LivenessProbe.
redis.livenessProbe.timeoutSeconds	int	5	Sets the timeoutSeconds property of LivenessProbe.
redis.livenessProbe.successThreshold	int	1	Sets the successThreshold property of LivenessProbe.
redis.livenessProbe.failureThreshold	int	5	Sets the failureThreshold property of LivenessProbe.
redis.resources	object	{}	Limit resources per container.
redis.extraVolumes	list	[]	Set the definition for additional volumes in the Pod.
redis.extraVolumeMounts	list	[]	Set up definitions for additional volume mounts on the Pod.
redis.extraEnv	list	[]	Set environment variables to add or change when running the container.
redis.auth	object	{}	Overrides database credential values. If not entered separately, default values are used. `redis: auth: password: "value"`
redisSentinel.service.port	int	26379	Change the port of the container to be deployed.
redisSentinel.service.annotations	object	{}	Sets the Service annotations property.
redisSentinel.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located.
redisSentinel.tolerations	list	[]	Sets the container's tolerations property.
redisSentinel.affinity	object	{}	Sets the container's affinity property.
redisSentinel.podAnnotations	object	{}	Sets the container's podAnnotations property.
redisSentinel.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe.
redisSentinel.livenessProbe.initialDelaySeconds	int	60	Sets the initialDelaySeconds property of LivenessProbe.
redisSentinel.livenessProbe.periodSeconds	int	10	Sets the periodSeconds property of LivenessProbe.
redisSentinel.livenessProbe.timeoutSeconds	int	5	Sets the timeoutSeconds property of LivenessProbe.
redisSentinel.livenessProbe.successThreshold	int	1	Sets the successThreshold property of LivenessProbe.
redisSentinel.livenessProbe.failureThreshold	int	5	Sets the failureThreshold property of LivenessProbe.
redisSentinel.resources	object	{}	Limit resources per container.
redisSentinel.extraVolumes	list	[]	Set the definition for additional volumes in the Pod.
redisSentinel.extraVolumeMounts	list	[]	Set up definitions for additional volume mounts on the Pod.
redisSentinel.extraEnv	list	[]	Set environment variables to add or change when running the container.
redisSentinel.auth	object	{}	Overrides database credential values. If not entered separately, default values are used. `redisSentinel: auth: masterName: "value"`
mongodb.service.port	int	27017	Change the port of the container to be deployed.
mongodb.service.annotations	object	{}	Sets the Service annotations property.
mongodb.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located.
mongodb.tolerations	list	[]	Sets the container's tolerations property.
mongodb.affinity	object	{}	Sets the container's affinity property.
mongodb.podAnnotations	object	{}	Sets the container's podAnnotations property.
mongodb.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe.
mongodb.livenessProbe.initialDelaySeconds	int	60	Sets the initialDelaySeconds property of LivenessProbe.
mongodb.livenessProbe.periodSeconds	int	10	Sets the periodSeconds property of LivenessProbe.
mongodb.livenessProbe.timeoutSeconds	int	5	Sets the timeoutSeconds property of LivenessProbe.
mongodb.livenessProbe.successThreshold	int	1	Sets the successThreshold property of LivenessProbe.
mongodb.livenessProbe.failureThreshold	int	5	Sets the failureThreshold property of LivenessProbe.
mongodb.resources	object	{}	Limit resources per container.
mongodb.persistence.enabled	bool	false	Sets whether to manage MongoDB's data directory using a separate storage volume.
mongodb.persistence.storageClass	string	nil	If using Kubernetes StorageClass, set the name.
mongodb.persistence.existingClaim	string	nil	If there is an existing Persistent Volume Claim (PVC), set its name. If no setting is made, a PVC will be created with a default name.
mongodb.persistence.accessMode	string	“ReadWriteOnce”	Sets the volume's access mode.
mongodb.persistence.size	string	"10Gi"	Sets the volume size.
mongodb.extraVolumes	list	[]	Set the definition for additional volumes in the Pod.
mongodb.extraVolumeMounts	list	[]	Set up definitions for additional volume mounts on the Pod.
mongodb.extraEnv	list	[]	Set environment variables to add or change when running the container.
mongodb.auth	object	{}	Overrides database credential values. If not entered separately, default values are used. `mongodb: auth: rootUsername: "value" rootPassword: "value" adminUsername: "value" adminPassword: "value"`
mongodb.adminIps	string	nil	Restricts the IPs allowed to access the administrator page. If not entered separately, all IP addresses are allowed.

Update settings

helm upgrade --install thinkfree oci://${ACCOUNT}.dkr.ecr.${REGION}.amazonaws.com/thinkfree-office-chart -f values.yaml

thinkfree: This corresponds to the Release Name in the Helm Chart; you must enter the Release Name you entered during installation.