This repository contains manifest files for deploying the beautiful prototyping application Quant-UX on a k8s cluster.
These manifest files can be deployed in local development environment using minikube.
To deploy the k8s manifest files from this repository in the local development environment, it is necessary to install the following applications:
The development environment was built on a Linux distro based on Ubuntu 18.04 LTS.
After installing the Docker, Minikube and Kubectl applications, from a terminal with administrator access (but not logged in as root), run to create a cluster locally:
minikube start
Enable ingress addon to manage external access to cluster services:
minikube addons enable ingress
Clone the repository:
git clone https://github.com/engmsilva/quant-ux-k8s.git
Run the deployment on the cluster:
cd quant-ux-k8s
kubectl apply -f ./k8s
Wait until all Pods are in Running status:
kubectl get pods --namespace=quant-ux
NAME READY STATUS RESTARTS AGE
quant-ux-backend-f9c875d99-9cmsn 1/1 Running 0 8m55s
quant-ux-frontend-5dc4d78f84-gtgqx 1/1 Running 0 8m55s
quant-ux-mongo-5446f69975-72jxn 1/1 Running 0 8m55s
quant-ux-websocket-77bcfd665f-xt45s 1/1 Running 0 8m55s
Check the local IP that is being routed to the cluster services:
kubectl get ingress --namespace=quant-ux
NAME CLASS HOSTS ADDRESS PORTS AGE
nginx-ingress nginx quant-ux.local 192.168.49.2 80 13h
Add the IP from the ADDRESS column in the /etc/hosts file to resolve name to address http://quant-ux.local:
192.168.49.2 quant-ux.local
Restart the networking service:
sudo service network-manager restart
Once all steps are completed Quant-UX will be available locally at the url http://quant-ux.local.
Quant-UX needs an email service to send messages to registered users in the application.
In the manifest file, the email service ethereal was configured. Ethereal is a fake free SMTP service where messages are never delivered which serves the purpose of development environment.
Messages delivered by Quant-UX can be viewed here, using the credentials below:
Email address: lily.gleason@ethereal.email
Password: epWxeJPEptDcXHNDm1
note: The fake Etheral SMTP service account is temporary, you may need to register a new account and change the information in the 06-qux-be-configmap.yaml manifest.
The secret manifest contains sensitive application security information. Change to best suit your project using the best practices for storing secrets .
The k8s cluster can be managed using the Minikube UI.
minikube dashboard
