Kubernetes on Azure

Context

The purpose of this document is to describe how to create the necessary infrastructure to deploy Vectice on a Kubernetes cluster in Azure, followed by instructions to deploy the Vectice software

Understanding prerequisites

Infrastructure requirements

Requirement

Notes or Details

Security Groups

Port 443 (HTTPS)

3128 Outbound (pip install)

SMTP Port (e.g 2525)

Kubernetes Cluster

v1.16+ deployed

2 nodes with Standard_B4ms

Azure Blob Storage Container

In the same region

Azure Database for PostgreSQL flexible server

13.x Cloud SQL instance

Other requirements

Requirement

Notes or Details

Domain Name

Example: https://vectice.my-company.com

SSL Certificate

Must be associated with the domain name above

Self-signed certificates are not recommended

Deployment environment with the following tools:

Helm v3

Kubectl

Azure CLI

Openssl

2. How to provision the infrastructure

You have two ways to create the infrastructure necessary for running Vectice.

Provisioning via Terraform (with Terragrunt Wrapper)

Expected Time: 40 minutes
Steps:
- Complete instructions, including the Terraform script, are found in the package your Vectice account team provided you. Contact support@vectice.com if you require assistance.

Provisioning via Azure portal

Expected Time: 2 hours
Steps:
- PostgreSQL Instance creation, see Appendix 1: Creating the SQL Instance
- Kubernetes cluster creation, see Appendix 2: Cluster Creation
- Blob Storage Creation, see Appendix 3: Creating the Blob Storage container

3. How to deploy the Vectice application

The provisioning of Vectice on Kubernetes will happen in 5 steps:

Step 1: Connect to the Cluster and Create the Vectice Namespace
Step 2: Install the Cert Manager
Step 3: Set up the Application Gateway on the cluster
Step 4: Create Secrets for Ingress and Docker Image Retriever
Step 5: Install the Vectice Stack

For any questions or assistance with deployment, please reach out to support@vectice.com

Step 1: Connect to the cluster and create the Vectice namespace

First, define the variables for the next steps and retrieve connections from your deployment machine. Below, sample values are provided between brackets:

AZURE_SUBSCRIPTION=<080kkb88-bf7d-44d-b46e-3302454g5r>
CLUSTER_NAME=<vectice-cluster>
RESOURCE_GROUP=<my-resource_group>
az account set --subscription $AZURE_SUBSCRIPTION
az aks get-credentials --resource-group $RESOURCE_GROUP --name $CLUSTER_NAME
CONTEXT=`kubectl config get-contexts | grep '*' |  grep '*' | awk '{print $2}'`

The expected output should look like this:

Merged "vectice-cluster" as current context in /home/wsl/.kube/config

Next, test the connection:

kubectl --context $CONTEXT get namespaces

The expected output should look like this:

NAME              STATUS   AGE
default           Active   3h54m
kube-node-lease   Active   3h54m
kube-public       Active   3h54m
kube-system       Active   3h54m

Finally, create the Vectice namespace where applications will be deployed:

kubectl --context $CONTEXT create namespace vectice

Step 2: Install the Cert Manager

Next, install the cert-manager and cert-manager-csi-driver applications on the cluster.

Cert-manager is used to implement SSL for internal communication between Vectice pods, Cert-manager-csi-driver will attach a csi volume containing the certificates to the Vectice pods

helm --kube-context $CONTEXT repo add jetstack https://charts.jetstack.io
helm --kube-context $CONTEXT repo update
helm --kube-context $CONTEXT install cert-manager jetstack/cert-manager -n cert-manager --create-namespace --set installCRDs=true
helm --kube-context $CONTEXT install cert-manager-csi-driver jetstack/cert-manager-csi-driver --create-namespace -n cert-manager

Next, generate a custom Certificate Authority and create its associated secret:

openssl req -x509 -nodes -newkey rsa:4096 -days 3650 -keyout /tmp/ca.key -out /tmp/ca.crt -subj '/CN=vectice-internal-ca' -addext "keyUsage = keyCertSign"
kubectl --context $CONTEXT create secret tls vectice-internal-ca -n vectice --cert=/tmp/ca.crt --key=/tmp/ca.key

Step 3: Set up the Application Gateway on the cluster

You can reuse an existing application gateway through the Azure portal.

To enable the AGIC add-on, go to the Kubernetes services page and select your Cluster. Go to the Networking to find the application gateway ingress controller section. Check the box next to Enable ingress controller, and Create a new Application Gateway by selecting the button “Create new.”

Add root-certificate to the application gateway

Once the application gateway is created, add the root certificate to the application gateway. Below, sample values are provided between brackets.

KUBE_RESSOURCE_GROUP=<kubernetes resource group>
az network application-gateway root-cert create --cert-file vectice-cluster-ca.crt --gateway-name ingress-appgateway -n vectice-internal-ca --resource-group $KUBE_RESSOURCE_GROUP

Step 4: Create Secrets for Ingress and Docker Image Retriever

First, create a self-signed certificate using the following command, replacing the item highlighted with your own Common Name (CN). Below, sample values are provided between brackets.

CNVALUE=<vectice.my-company.com>
openssl req -x509 -nodes -newkey rsa:2048 -days 3650 -keyout /tmp/vectice-cert.key -out /tmp/vectice-cert.crt -subj "/CN=$CNVALUE"

Then, use the command below to install your certificates in the cluster

kubectl --context $CONTEXT create secret tls vectice-private-https -n vectice --cert=/tmp/vectice-cert.crt --key=/tmp/vectice-cert.key

Once this is done, navigate to the location of the vectice-image-puller.json file. This is found in the package your Vectice account team provided you. Contact support@vectice.com if you require assistance. Use this file to create the secret that will be used to pull the docker images from the Vectice GCR registry:

kubectl --context $CONTEXT create secret docker-registry vectice-gcr-secrets -n vectice \
--docker-server=gcr.io \
--docker-username=_json_key \
--docker-password="$(cat vectice-image-puller.json)" \
--docker-email=$(cat vectice-image-puller.json | grep "client_email" | grep -Po '"client_email": "\K[^"]*')

Step 5: Install the Vectice Stack

From the package your account team provided, untar helm vectice chart and create myvalues.yml from values.yml file. Below, sample values are provided between brackets.

Please refer to the configuration page and comments inside the file myvalues.yaml to customize values.

VERSION=<241.1.0>
tar -xvf vectice-$VERSION.tgz
cd vectice-$VERSION
cp values.yaml myvalues.yaml

Next, fill in the values in myvalues.yaml according to your environment deployment, and deploy Vectice global objects using Helm

cd ..
helm --kube-context $CONTEXT upgrade --install vectice vectice -f vectice/myvalues.yaml -n vectice --create-namespace --wait

Once this is done, retrieve the Vectice ingress IP. Note: this might take up to 5 minutes to appear

kubectl --context $CONTEXT get ingress vectice -n vectice

The expected output should look like this. Below are example values:

NAME      CLASS                      HOSTS                    ADDRESS   PORTS     AGE
vectice   azure-application-gateway  vectice.my-company.com   2.3.4.5   80, 443   1d

Finally, add the A record as a new entry in your DNS resolver.

Learn more about A DNS records.

In this example, the A record would look like below:

DOMAIN             RECORD TYPE     NAME        CONTENT
my-company.com     A               vectice     2.3.4.5

PreviousAppendices NextAppendices