Skip to content
Snippets Groups Projects
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
Name Last commit Last update
..
templates
Chart.yaml
README.md
values.yaml

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

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.logLevel logging severity level for this service only string - yes, only if differs from the global.logLevel
data.defaultDataCountry Data storage region string US yes
data.storageServiceAccountEmail Storage service account email, used during OQM events processing string storage@service.local yes
data.entitlementsHost Entitlements service host address string http://entitlements yes
data.partitionHost Partition service host address string http://partition yes
data.crsConverterHost CRS Converter service host address string http://crs-conversion yes
data.legalHost Legal service host address string http://legal yes
data.opaEndpoint OPA host address string http://opa yes
data.redisStorageHost The host for redis instance. If empty (by default), helm installs an internal redis instance string - yes
data.redisStoragePort The port for redis instance digit 6379 yes

Deployment variables

Name Description Type Default Required
data.requestsCpu amount of requested CPU string 10m yes
data.requestsMemory amount of requested memory string 650Mi yes
data.limitsCpu CPU limit string 1 only if global.limitsEnabled is true
data.limitsMemory memory limit string 3G only if global.limitsEnabled is true
data.image path to the image in a registry string - yes
data.imagePullPolicy when to pull the image string IfNotPresent yes
data.serviceAccountName name of kubernetes service account string storage yes
data.redisImage service image string redis:7 yes

Configuration variables

Name Description Type Default Required
conf.appName Service name string storage yes
conf.storageRedisSecretName secret for redis that contains redis password with REDIS_PASSWORD key string storage-redis-secret yes
conf.replicas Number of replicas integer 3 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

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 20 only if global.autoscaling is true and global.tier is PROD
hpa.targetType type of measurements: AverageValue or Value string "AverageValue" only if global.autoscaling is true and global.tier is PROD
hpa.targetValue threshold value to trigger the scaling up integer 45 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 10 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 50 only if global.autoscaling is true and global.tier is PROD
hpa.behaviorScaleUpPoliciesPeriodSeconds pause for every new scale up decision integer 15 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 25 only if global.autoscaling is true and global.tier is PROD
hpa.behaviorScaleDownPoliciesPeriodSeconds pause for every new scale down decision integer 60 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 30 only if global.autoscaling is true and global.tier is PROD
limits.tokensPerFill number of new tokens allowed every fillInterval integer 30 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

Methodology for Parameter Calculation variables: hpa.targetValue, limits.maxTokens and limits.tokensPerFill

The parameters hpa.targetValue, limits.maxTokens and limits.tokensPerFill were determined through empirical testing during load testing. These tests were conducted using the N2D machine series, which can run on either AMD EPYC Milan or AMD EPYC Rome processors. The values were fine-tuned to ensure optimal performance under typical workloads.

Recommendations for New Instance Types

When changing the instance type to a newer generation, such as the C3D series, it is essential to conduct new load testing. This ensures the parameters are recalibrated to match the performance characteristics of the new processor architecture, optimizing resource utilization and maintaining application stability.

Install the Helm chart

Run this command from within this directory:

helm install gc-storage-deploy .

Uninstall the Helm chart

To uninstall the helm deployment:

helm uninstall gc-storage-deploy

Do not forget to delete all k8s secrets and PVCs accociated with the Service.

Move-to-Top