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)

Istio is installed with Istio Ingress Gateway

• Kubernetes cluster version can be checked with the command:

  kubectl version --short | grep Server

  The output will be similar to the following:

  Server Version: v1.21.11-gke.1100

• Istio version can be checked in different ways, it is out of scope for this README. You can find more information here.

  The following command shows how to check version if Anthos Service Mesh is used:

  kubectl -n istio-system get pods -lapp=istiod -o=jsonpath='{.items[0].metadata.labels.istio\.io/rev}'

  The output will be similar to the following:

  asm-1132-5

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

This example describes installation in Development mode:

• In this mode helm chart is installed to the namespace not labeled with Istio.

  More information about labeling can be found here (Istio) or here (Anthos Service Mesh)

  You can find all labels for your namespace with the command:

  kubectl get namespace <namespace> -o jsonpath={.metadata.labels}

  The output shows that there are no any labels related to Istio:

  {"kubernetes.io/metadata.name":"default"}

  When the namespace is labeled with Istio, the output could be:

  {"istio-injection":"enabled","kubernetes.io/metadata.name":"default"}

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

  Helm version can be checked with the command:

  helm version --short

  The output will be similar to the following:

  v3.7.1+gd141386

• Kubectl (version: v1.21.0 or higher) kubectl

  Kubectl version can be checked with the command:

  kubectl version --short | grep Client

  The output will be similar to the following:

  Client Version: v1.21.0

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.

Configmap variables

Name	Description	Type	Default	Required
logLevel	logging level	string	ERROR	yes
springProfilesActive	active spring profile	string	gcp	yes
acceptHttp	accept Http traffic	string	true	yes
dataPartitionId	data partition id	string	-	yes
entitlementsHost	Entitlements host URL	string	http://entitlements	yes
defaultLegalTag	Default legal tag	string	default-data-tag	yes
legalHost	Legal host URL	string	http://legal	yes

Deployment variables

Name	Description	Type	Default	Required
requestsCpu	amount of requests CPU	string	0.1	yes
requestsMemory	amount of requests memory	string	384M	yes
limitsCpu	CPU limit	string	1	yes
limitsMemory	memory limit	string	1G	yes
bootstrapImage	name of the bootstrap image	string	-	yes
bootstrapServiceAccountName	name of the bootstrap service account	string	-	yes
serviceAccountName	name of your service account	string	legal	yes
imagePullPolicy	when to pull the image	string	IfNotPresent	yes
image	path to the image in a registry	string	-	yes

Configuration variables

Name	Description	Type	Default	Required
configmap	configmap to be used	string	legal-config	yes
appName	name of the app	string	legal	yes
minioSecretName	Secret name for minio service	string	legal-minio-secret	yes
postgresSecretName	Secret name for postgres service	string	legal-postgres-secret	yes
rabbitmqSecretName	Secret name for rabbitmq service	string	rabbitmq-secret	yes
bootstrapSecretName	Secret name for bootstrap	string	datafier-secret	yes
onPremEnabled	whether on-prem is enabled	boolean	false	yes
istionEnabled	whether enable istio resources	boolean	true	yes
bootstrapEnabled	whether bootstrap is enabled	boolean	false	yes
domain	your domain	string	-	yes

Install the helm chart

Run this command from within this directory:

helm install gc-legal-deploy .

Uninstalling the Chart

To uninstall the helm deployment:

helm uninstall gc-legal-deploy

To delete secrets and PVCs:

kubectl delete secret --all; kubectl delete pvc --all

Move-to-Top