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.onPremEnabled	whether on-prem is enabled	boolean	false	yes
global.limitsEnabled	whether CPU and memory limits are enabled	boolean	true	yes

Configmap variables

Name	Description	Type	Default	Required
data.logLevel	logging level	string	INFO	yes
data.springProfilesActive	active spring profile	string	gcp	yes
data.entitlementsHost	entitlements service host address	string	http://entitlements	yes
data.registerHost	register service host address	string	http://register	yes
data.partitionHost	partition service host address	string	http://partition	yes
data.redisNotificationHost	The host for redis instance. If empty, helm installs an internal redis instance	string	redis-notification	yes
data.redisNotificationPort	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	512Mi	yes
data.limitsCpu	CPU limit	string	1	only if global.limitsEnabled is true
data.limitsMemory	memory limit	string	1.5G	only if global.limitsEnabled is true
data.serviceAccountName	name of your service account	string	notification	yes
data.imagePullPolicy	when to pull image	string	IfNotPresent	yes
data.image	service image	string	-	yes
data.redisImage	redis image	string	redis:7	yes

Config variables

Name	Description	Type	Default	Required
conf.appName	Service name	string	notification	yes
conf.configmap	configmap to be used	string	notification-config	yes
conf.rabbitmqSecretName	secret for rabbitmq	string	rabbitmq-secret	yes
conf.openidSecretName	secret for openid	string	notification-keycloak-secret	yes
conf.notificationRedisSecretName	Notification redis secret	string	notification-redis-secret	yes
conf.redisSSL	Redis host ssl config. External redis configuration only if true	string	false	no

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

Install the helm chart

Run this command from within this directory:

helm install gcp-notification-deploy .

Uninstalling the Chart

To uninstall the helm deployment:

helm uninstall gcp-notification-deploy

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

Move-to-Top