README.md

Deploy helm chart

Introduction

This chart bootstraps a deployment on a Kubernetes cluster using Helm package manager.

Prerequisites

The code was tested on Kubernetes cluster (v1.21.11) with Istio (1.12.6)

It is possible to use other versions, but it hasn't been tested

Operation system

The code works in Debian-based Linux (Debian 10 and Ubuntu 20.04) and Windows WSL 2. Also, it works but is not guaranteed in Google Cloud Shell. All other operating systems, including macOS, are not verified and supported.

Packages

Packages are only needed for installation from a local computer.

• HELM (version: v3.7.1 or higher) helm
• Kubectl (version: v1.21.0 or higher) kubectl

Installation

Before installing deploy Helm chart you need to install configmap Helm chart. First you need to set variables in values.yaml file using any code editor. Some of the values are prefilled, but you need to specify some values as well. You can find more information about them below.

Global variables

Name	Description	Type	Default	Required
global.domain	your domain for the external endpoint, ex example.com	string	-	yes
global.limitsEnabled	whether CPU and memory limits are enabled	boolean	true	yes
global.logLevel	severity of logging level	string	ERROR	yes
global.tier	Only PROD must be used to enable autoscaling	string	""	no
global.autoscaling	enables horizontal pod autoscaling, when tier=PROD	boolean	true	yes

Configmap variables

Name	Description	Type	Default	Required
data.entitlementsHost	entitlements host	string	http://entitlements	yes
data.logLevel	logging severity level for this service only	string	-	yes, only if differs from the global.logLevel
data.partitionHost	partition host	string	http://partition	yes
data.schemaHost	schema host	string	http://schema	yes
data.securityHttpsCertificateTrust	whether https is enabled	boolean	true	yes
data.storageHost	storage host	string	http://storage	yes
data.redisIndexerHost	The host for redis instance. If empty (by default), helm installs an internal redis instance	string	-	yes
data.redisIndexerPort	The port for redis instance	digit	6379	yes

Deploy variables

Name	Description	Type	Default	Required
data.requestsCpu	amount of requested CPU	string	35m	yes
data.requestsMemory	amount of requested memory	string	640Mi	yes
data.limitsCpu	CPU limit	string	1	only if global.limitsEnabled is true
data.limitsMemory	memory limit	string	1G	only if global.limitsEnabled is true
data.image	service image	string	-	yes
data.imagePullPolicy	when to pull image	string	IfNotPresent	yes
data.serviceAccountName	name of your service account	string	indexer	yes
data.redisImage	service image	string	redis:7	yes

Config variables

Name	Description	Type	Default	Required
conf.appName	name of the app	string	indexer	yes
conf.configmap	configmap to be used	string	indexer-config	yes
conf.elasticSecretName	secret for elastic	string	indexer-elastic-secret	yes
conf.indexerRedisSecretName	indexer Redis secret that contains redis password with REDIS_PASSWORD key	string	indexer-redis-secret	yes

ISTIO variables

Name	Description	Type	Default	Required
istio.proxyCPU	CPU request for Envoy sidecars	string	10m	yes
istio.proxyCPULimit	CPU limit for Envoy sidecars	string	200m	yes
istio.proxyMemory	memory request for Envoy sidecars	string	100Mi	yes
istio.proxyMemoryLimit	memory limit for Envoy sidecars	string	256Mi	yes
istio.sidecarInject	whether Istio sidecar will be injected. Setting to false reduces security, because disables authorization policy.	boolean	true	yes

Horizontal Pod Autoscaling (HPA) variables (works only if tier=PROD and autoscaling=true)

Name	Description	Type	Default	Required
hpa.minReplicas	minimum number of replicas	integer	6	only if global.autoscaling is true and global.tier is PROD
hpa.maxReplicas	maximum number of replicas	integer	15	only if global.autoscaling is true and global.tier is PROD
hpa.pubsubTargetType	type of measurements: AverageValue	string	"AverageValue"	only if global.autoscaling is true and global.tier is PROD
hpa.pubsubTargetValue	threshold value to trigger the scaling up	integer	50	only if global.autoscaling is true and global.tier is PROD
hpa.cpuTargetType	type of measurements: Utilization	string	"Utilization"	only if global.autoscaling is true and global.tier is PROD
hpa.cpuTargetValue	threshold value to trigger the scaling up	integer	70	only if global.autoscaling is true and global.tier is PROD
hpa.memoryTargetType	type of measurements: Utilization	string	"Utilization"	only if global.autoscaling is true and global.tier is PROD
hpa.memoryTargetValue	threshold value to trigger the scaling up	integer	70	only if global.autoscaling is true and global.tier is PROD
hpa.behaviorScaleUpStabilizationWindowSeconds	time to start implementing the scale up when it is triggered	integer	60	only if global.autoscaling is true and global.tier is PROD
hpa.behaviorScaleUpPoliciesValue	the maximum number of new replicas to create (in percents from current state)	integer	1	only if global.autoscaling is true and global.tier is PROD
hpa.behaviorScaleUpPoliciesPeriodSeconds	pause for every new scale up decision	integer	120	only if global.autoscaling is true and global.tier is PROD
hpa.behaviorScaleDownStabilizationWindowSeconds	time to start implementing the scale down when it is triggered	integer	60	only if global.autoscaling is true and global.tier is PROD
hpa.behaviorScaleDownPoliciesValue	the maximum number of replicas to destroy (in percents from current state)	integer	1	only if global.autoscaling is true and global.tier is PROD
hpa.behaviorScaleDownPoliciesPeriodSeconds	pause for every new scale down decision	integer	120	only if global.autoscaling is true and global.tier is PROD

Limits variables

Name	Description	Type	Default	Required
limits.maxTokens	maximum number of requests per fillInterval	integer	50	only if global.autoscaling is true and global.tier is PROD
limits.tokensPerFill	number of new tokens allowed every fillInterval	integer	50	only if global.autoscaling is true and global.tier is PROD
limits.fillInterval	time interval	string	"1s"	only if global.autoscaling is true and global.tier is PROD

Install the helm chart

Run this command from within this directory:

helm install gc-indexer-deploy .

Uninstalling the Chart

To uninstall the helm deployment:

helm uninstall gc-indexer-deploy

Move-to-Top