Setting up Thinkfree Office Helm Chart

Modified on Wed, 25 Jun at 4:28 PM

This document provides guidance on setting up the Thinkfree Office Helm Chart. Helm Charts enable users to customize their container deployment environment by editing configuration files. A variety of configurable properties are available. Use this guide to identify and modify the settings relevant to your needs, then apply them to your container environment. If you haven’t yet downloaded the configuration files, please refer to the install Thinkfree Office guide.

Settings File Configuration

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 Value	Description
nameOverride	string	nil	Change HelmChart name
namespaceOverride	string	nil	Change namespace in which HelmChart is installed. If not specified separately, it will follow the namespace in which HelmChart is installed
image.registry	string	“958750823146.dkr.ecr.ap-northeast-2.amazonaws.com”	Enter the container image registry address
image.tag	string	“2.5.4”	Enter a container image tag
image.pullPolicy	string	“IfNotPresent”	Enter a container image pull policy
image.pullSecrets	list	[]	Enter the Secret name for the container image pull
serviceAccount.create	bool	true	Sets whether to use ServiceAccount
serviceAccount.name	string	nil	Set the ServiceAccount name
serviceAccount.annotations	object	{}	Set the ServiceAccount annotations properties
serviceAccount.automountServiceAccountToken	bool	true	Set the ServiceAccount automountServiceAccountToken property
rbac.enabled	bool	true	Sets RBAC (Role-Based Access Control) of Kubernetes. Used for Kubernetes authentication when clustering Hazelcast. Change it to false only in environments that cannot handle Kubernetes authentication. And if changed to false, Pod can only guarantee operation in environments where it is set to 1.
was.image.repository	string	“thinkfree-office-was”	Enter the WAS container image repository address
was.appName	string	nil	Change the name of Thinkfree Office WAS
was.replicaCount	int	1	Change the number of containers to deploy
was.service.port	int	80	Change the port of the container to be deployed
was.service.annotations	object	{}	Sets the service annotations properties
was.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located
was.readinessProbe.enabled	bool	true	Sets whether to use ReadinessProbe
was.readinessProbe.failureThreshold	int	4	Set the failureThreshold property of ReadinessProbe
was.readinessProbe.initialDelaySeconds	int	0	Set the initialDelaySeconds property of ReadinessProbe
was.readinessProbe.periodSeconds	int	15	Set the periodSeconds property of ReadinessProbe
was.readinessProbe.successThreshold	int	1	Set the successThreshold property of ReadinessProbe
was.readinessProbe.timeoutSeconds	bool	true	Set the timeoutSeconds property of ReadinessProbe
was.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe
was.livenessProbe.failureThreshold	int	3	Set the failureThreshold property of LivenessProbe
was.livenessProbe.initialDelaySeconds	int	60	Set the initialDelaySeconds property of LivenessProbe
was.livenessProbe.periodSeconds	int	20	Set the periodSeconds property of LivenessProbe
was.livenessProbe.successThreshold	int	1	Set the successThreshold property of LivenessProbe
was.livenessProbe.timeoutSeconds	int	10	Set the timeoutSeconds property of LivenessProbe
was.resource	object	{}	Limit resources per container
was.autoscaling.enabled	bool	true	Sets whether to use HPA (Horizontal Pod Autoscaler)
was.autoscaling.minReplicas	int	1	Set the minReplicas property of the Horizontal Pod Autoscaler (HPA)
was.autoscaling.maxReplicas	int	3	Set the maxReplicas property of the Horizontal Pod Autoscaler (HPA)
was.autoscaling.targetCPU	string	"50"	Set the targetCPU property of HPA (Horizontal Pod Autoscaler)
was.autoscaling.targetMemory	string	"80"	Set the targetMemory property of the HPA (Horizontal Pod Autoscaler)
was.ingress.enabled	bool	false	Sets whether Ingress is used
was.ingress.annotations	object	{}	Sets the annotations property of Ingress
was.ingress.hosts	list	[]	Set the hosts property of Ingress
was.ingress.paths	list	[]	Sets the paths property of an Ingress
was.ingress.pathType	string	nil	Sets the pathType property of an Ingress
was.ingress.tls	list	[]	Set the tls property of Ingress
broker.image.repository	string	“thinkfree-office-broker”	Enter the Broker container image repository address
broker.appName	string	nil	Change the name of Thinkfree Office Broker
broker.replicaCount	int	1	Change the number of containers to be deployed. Thinkfree Office Broker operates in Active-StandBy mode. Therefore, Pod can only be guaranteed to operate in an environment where a maximum of 2 Pods are set.
broker.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located
broker.resource	object	{}	Limit resources per container
filter.image.repository	string	“thinkfree-office-filter”	Enter the Filter container image repository address
filter.appName	string	nil	Rename ThinkfreeOffice Filter
filter.replicaCount	int	1	Change the number of containers to deploy
filter.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located
filter.resource	object	{}	Limit resources per container
filter.autoscaling.enabled	bool	true	Sets whether to use HPA (Horizontal Pod Autoscaler)
filter.autoscaling.minReplicas	int	1	Set the minReplicas property of the Horizontal Pod Autoscaler (HPA)
filter.autoscaling.maxReplicas	int	3	Set the maxReplicas property of the Horizontal Pod Autoscaler (HPA)
filter.autoscaling.targetCPU	string	“50”	Set the targetCPU property of HPA (Horizontal Pod Autoscaler)
filter.autoscaling.targetMemory	string	“80”	Set the targetMemory property of the HPA (Horizontal Pod Autoscaler)
document.word.image.repository	string	“thinkfree-office-document-word”	Enter the Document-Word container image repository address
document.word.appName	string	nil	Rename ThinkfreeOffice Document-Word
document.word.replicaCount	int	1	Change the number of containers to deploy
document.word.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located
document.word.readinessProbe.enabled	bool	true	Sets whether to use ReadinessProbe
document.word.readinessProbe.failureThreshold	int	4	Set the failureThreshold property of ReadinessProbe
document.word.readinessProbe.initialDelaySeconds	int	0	Set the initialDelaySeconds property of ReadinessProbe
document.word.readinessProbe.periodSeconds	int	15	Set the periodSeconds property of ReadinessProbe
document.word.readinessProbe.successThreshold	int	1	Set the successThreshold property of ReadinessProbe
document.word.readinessProbe.timeoutSeconds	int	5	Set the timeoutSeconds property of ReadinessProbe
document.word.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe
document.word.livenessProbe.failureThreshold	int	3	Set the failureThreshold property of LivenessProbe
document.word.livenessProbe.initialDelaySeconds	int	30	Set the initialDelaySeconds property of LivenessProbe
document.word.livenessProbe.periodSeconds	int	20	Set the periodSeconds property of LivenessProbe
document.word.livenessProbe.successThreshold	int	1	Set the successThreshold property of LivenessProbe
document.word.livenessProbe.timeoutSeconds	int	5	Set the timeoutSeconds property of LivenessProbe
document.word.resource	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	Set the minReplicas property of the Horizontal Pod Autoscaler (HPA)
document.word.autoscaling.maxReplicas	int	3	Set the maxReplicas property of the Horizontal Pod Autoscaler (HPA)
document.word.autoscaling.targetCPU	string	"50"	Set the targetCPU property of HPA (Horizontal Pod Autoscaler)
document.word.autoscaling.targetMemory	string	"80"	Set the targetMemory property of the HPA (Horizontal Pod Autoscaler)
document.show.image.repository	string	“thinkfree-office-document-show”	Enter the Document-Show container image repository address
document.show.appName	string	nil	Rename ThinkfreeOffice Document-Show
document.show.replicaCount	int	1	Change the number of containers to deploy
document.show.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located
document.show.readinessProbe.enabled	bool	true	Sets whether to use ReadinessProbe
document.show.readinessProbe.failureThreshold	int	4	Set the failureThreshold property of ReadinessProbe
document.show.readinessProbe.initialDelaySeconds	int	0	Set the initialDelaySeconds property of ReadinessProbe
document.show.readinessProbe.periodSeconds	int	15	Set the periodSeconds property of ReadinessProbe
document.show.readinessProbe.successThreshold	int	1	Set the successThreshold property of ReadinessProbe
document.show.readinessProbe.timeoutSeconds	int	5	Set the timeoutSeconds property of ReadinessProbe
document.show.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe
document.show.livenessProbe.failureThreshold	int	3	Set the failureThreshold property of LivenessProbe
document.show.livenessProbe.initialDelaySeconds	int	30	Set the initialDelaySeconds property of LivenessProbe
document.show.livenessProbe.periodSeconds	int	20	Set the periodSeconds property of LivenessProbe
document.show.livenessProbe.successThreshold	int	1	Set the successThreshold property of LivenessProbe
document.show.livenessProbe.timeoutSeconds	int	5	Set the timeoutSeconds property of LivenessProbe
document.show.resource	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	Set the minReplicas property of the Horizontal Pod Autoscaler (HPA)
document.show.autoscaling.maxReplicas	int	3	Set the maxReplicas property of the Horizontal Pod Autoscaler (HPA)
document.show.autoscaling.targetCPU	string	"50"	Set the targetCPU property of HPA (Horizontal Pod Autoscaler)
document.show.autoscaling.targetMemory	string	"80"	Set the targetMemory property of the HPA (Horizontal Pod Autoscaler)
redis.image.repository	string	“thinkfree-office-redis”	Enter the Redis container image repository address
redis.appName	string	nil	Change the name of ThinkfreeOffice Redis
redis.replicaCount	int	1	Change the number of containers to deploy
redis.service.port	int	6379	Change the port of the container to be deployed
redis.service.annotations	object	{}	Sets the service annotations properties
redis.nodeSelector	object		Change the scheduling policy of the Pod where the container will be located
redis.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe
redis.livenessProbe.failureThreshold	int	3	Set the failureThreshold property of LivenessProbe
redis.livenessProbe.initialDelaySeconds	int	15	Set the initialDelaySeconds property of LivenessProbe
redis.livenessProbe.periodSeconds	int	20	Set the periodSeconds property of LivenessProbe
redis.livenessProbe.successThreshold	int	1	Set the successThreshold property of LivenessProbe
redis.livenessProbe.timeoutSeconds	int	5	Set the timeoutSeconds property of LivenessProbe
redis.resource	object	{}	Limit resources per container
redis.extraVolumes	list	[]	Defines additional volumes for a Pod.
redis.extraVolume	list	[]	Defines additional volume mounts to the Pod.
redis.env	list	[]	Changes values for environment variables. The environment variables that can be changed are as follows: env: - name: REDIS_PASSWORD value: "value"
redisSentinel.image.repository	string	“thinkfree-office-redis-sentinel”	Enter the Redis-Sentinel container image repository address
redisSentinel.appName	string	nil	Rename ThinkfreeOffice Redis-Sentinel
redisSentinel.replicaCount	int	1	Change number of containers to deploy
redisSentinel.service.port	int	26379	Change the port of the container to be deployed
redisSentinel.service.annotations	object	{}	Sets the service annotations properties
redisSentinel.nodeSelector	object	{}	Change scheduling policy of the Pod where the container will be located.
redisSentinel.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe
redisSentinel.livenessProbe.failureThreshold	int	3	Set the failureThreshold property of LivenessProbe
redisSentinel.livenessProbe.initialDelaySeconds	int	15	Set the initialDelaySeconds property of LivenessProbe
redisSentinel.livenessProbe.periodSeconds	int	20	Set the periodSeconds property of LivenessProbe
redisSentinel.livenessProbe.successThreshold	int	1	Set the successThreshold property of LivenessProbe
redisSentinel.livenessProbe.timeoutSeconds	int	5	Set the timeoutSeconds property of LivenessProbe
redisSentinel.resource	object	{}	Limit resources per container
redisSentinel.extraVolumes	list	[]	Defines additional volumes for a Pod.
redisSentinel.extraVolumeMounts	list	[]	Defines additional volume mounts to the Pod.
redisSentinel.env	list	[]	Changes values for environment variables. The environment variables that can be changed are as follows: env: - name: REDIS_SENTINEL_MASTER_NAME value: "value"
mongodb.image.repository	string	“thinkfree-office-mongodb”	Enter the MongoDB container image repository address
mongodb.appName	string	nil	Change the name of ThinkfreeOffice MongoDB
mongodb.replicaCount	int	1	Change the number of containers to deploy
mongodb.service.port	int	27017	Change the port of the container to be deployed
mongodb.service.annotations	object	{}	Sets the service annotations properties
mongodb.nodeSelector	object	{}	Change the scheduling policy of the Pod where the container will be located
mongodb.livenessProbe.enabled	bool	true	Sets whether to use LivenessProbe
mongodb.livenessProbe.failureThreshold	int	3	Set the failureThreshold property of LivenessProbe
mongodb.livenessProbe.initialDelaySeconds	int	30	Set the initialDelaySeconds property of LivenessProbe
mongodb.livenessProbe.periodSeconds	int	20	Set the periodSeconds property of LivenessProbe
mongodb.livenessProbe.successThreshold	int	1	Set the successThreshold property of LivenessProbe
mongodb.livenessProbe.timeoutSeconds	int	5	Set the timeoutSeconds property of LivenessProbe
mongodb.resource	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 you use Kubernetes StorageClass, set the name.
mongodb.persistence.existingClaim	string	nil	If you have an existing PVC (Persistent Volume Claim) in use, set its name. If you do not set anything, a PVC will be created with the default name.
mongodb.persistence.accessMode	string	"ReadWriteOnce"	Sets the access mode of the volume.
mongodb.persistence.size	string	"10Gi"	Sets the size of the volume.
mongodb.extraVolumes	list	[]	Defines additional volumes for a Pod.
mongodb.extraVolumeMounts	list	[]	Defines additional volume mounts to the Pod.
mongodb.env	list	[]	Changes values for environment variables. The environment variables that can be changed are as follows: env: - name: MONGODB_ROOT_DB value: "value" - name: MONGODB_ROOT_USERNAME value: "value" - name: MONGODB_ROOT_PASSWORD value: "value" - name: MONGODB_ADMIN_DB value: "value" - name: MONGODB_ADMIN_USERNAME value: "value" - name: MONGODB_ADMIN_PASSWORD value: "value" - name: MONGODB_WORD_DB value: "value" - name: MONGODB_WORD_USERNAME value: "value" - name: MONGODB_WORD_PASSWORD value: "value" - name: MONGODB_CELL_DB value: "value" - name: MONGODB_CELL_USERNAME value: "value" - name: MONGODB_CELL_PASSWORD value: "value" - name: MONGODB_SHOW_DB value: "value" - name: MONGODB_SHOW_USERNAME value: "value" - name: MONGODB_SHOW_PASSWORD value: "value" - name: MONGODB_FILE_DB value: "value" - name: MONGODB_FILE_USERNAME value: "value" - name: MONGODB_FILE_PASSWORD value: "value" - name: MONGODB_ADMIN_IPS value: "value"

Update settings

helm upgrade thinkfree oci://958750823146.dkr.ecr.ap-northeast-2.amazonaws.com/thinkfree-office-chart -f values.yaml

thinkfree: This is the section corresponding to the Release Name of the Helm Chart. You must enter the Release Name you entered during installation.