VaaS

VaaS Visualization tool for OpenFaas

NOTE: The initial instructions below are meant to get you in and testing the development version of VaaS as quickly as possible - RZ

Before firing up and installing VaaS, please make sure to have...

1. your Kuberenetes clusters set up and ports open
2. created a Prometheus deployment - with ports properly forwarded: https://devopscube.com/setup-prometheus-monitoring-on-kubernetes/
3. Set up Kube State metrics: https://devopscube.com/setup-kube-state-metrics/
4. Set up node exporter; https://devopscube.com/node-exporter-kubernetes/

Skip to appropriate section -

Prerequisites ( OPTIONAL ) Create a containerized image of your application

1. Set up a Kubernetes cluster https://kubernetes.io/docs/tasks/tools/
   a) Setting up Kind to run local cluster: https://kind.sigs.k8s.io/docs/user/quick-start/
   b) Setting up minikube to run local cluster: https://minikube.sigs.k8s.io/docs/start/
   c) Install kubectl
   
2. Deploying Prometheus onto you clusters: https://devopscube.com/setup-prometheus-monitoring-on-kubernetes/
   a) Follow the guide to deploy and port forward properly - keep track of the monitoring pods and which port you're forwarding it to on localhost
   
3. Deploy OpenFaaS to Kubernetes: https://goncalo-a-oliveira.medium.com/setting-up-openfaas-with-minikube-28ed2f78dd1b
   a) Again keep track of your password, take special note of the command and how to temporarily store it as a temporary environment variable b) Note: If you close the terminal/command prompt you will have to refetch and reassign the PASSWORD before you can use the OpenFaaS CLI to sign in

If you want to set up and play with multiple clusters, make sure to have kind (requires Docker) and minikube up and running

1. Navigating and moving between clusters
   i) To see all clusters - take note of the cluster names
   kubectl config view
   ii) To see current cluster
   kubectl config current-context
   iii) To switch into the cluster you want to configure/port forward
   kubectl config use-context [clusterName]
   iv) From here follow the steps under the "Using Kubectl port forwarding" - in link found in Step 2 of the pre-requisites
   

Documentation on best practice utilizing configuration files (recommended read): https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/

Installation

1. Clone this repository onto your local machine

 git clone https://github.com/oslabs-beta/VaaS.git

2. Install dependencies

npm install or npm install --legacy-peer-deps

3. Set up .env file (create in root of VaaS folder)

JWT_ACCESS_SECRET=hello
JWT_REFRESH_SECRET=hello
JWT_EXP=400000000
JWT_GRACE=4000000000np

MONGO_URL=@
MONGO_PORT=
MONGO_USERNAME=
MONGO_PASSWORD=
MONGO_COLLECTION=

EXPRESS_PORT=3020
EXPRESS_CONSOLE_LOG=on

4. Run the app with

npm run dev

Set up order: You will need to port-forward Promethesus and openFaaS Grafana will need to be changed to port 3001 in customs.ini, but that will be in the documentation as well.

https://www.docker.com/products/docker-desktop/ https://minikube.sigs.k8s.io/docs/start/ https://goncalo-a-oliveira.medium.com/ https://github.com/alexellis/arkade

curl -sLS https://get.arkade.dev | sh --> WE TOOK OUT SUDO

How to deploy custom functions: kubectl port-forward -n openfaas svc/gateway 30001:8080 export OPENFAAS_URL=http://127.0.0.1:30001/ PASSWORD=$(kubectl get secret -n openfaas basic-auth -o jsonpath="{.data.basic-auth-password}" | base64 --decode; echo) echo -n $PASSWORD | faas-cli login --username admin --password-stdin echo $PASSWORD echo -n $PASSWORD | faas-cli login - username --password Ii4Rg1Gd1ONf976TJ65tts2m0 faas-cli template store pull node faas-cli new --lang node --prefix=DOCKERUSERNAME NAMEOFFILE faas-cli up --skip-deploy -f NAMEOFFILE.yml faas-cli deploy -f NAMEOFFILE

https://grafana.com/docs/grafana/latest/ how to install grafana:

1. curl -O https://dl.grafana.com/oss/release/grafana-7.1.5.darwin-amd64.tar.gz
2. tar -xvf myfile.tar -C somedirectory
3. add customs.ini (i just copied/pasted and changed embed)
4. go to where untar then ./bin/grafana-server web
5. CHANGE PORT TO 3001 IN CUSTOMS
6. share panel embed

Creating Clusters: Cluster URL: "http://localhost" Kubernetes Port: 30000 FaaS Port: 30001 FaaS Username: admin FaaS Password: From the guild Cluster Name: You choose Chuster Description: You choose