README.md

Setting up Minikube and OpenFaaS(Part I)

This guide outlines the steps to set up Minikube and deploy OpenFaaS on Minikube, along with retrieving the admin password for accessing OpenFaaS.

Prerequisites

Before you begin, ensure you have the following tools installed:

• Minikube
• Helm

Step 1: Install Minikube

1. Download and install Minikube from the official website: Minikube Installation Guide

2. Start Minikube:

   minikube start --addons metrics-server

Step 2: Set Up Minikube's Docker Environment

1. Ensure your shell is configured to use Minikube's Docker environment:

   eval $(minikube docker-env)

Step 3: Install Helm

1. Install Helm, a Kubernetes package manager:

   curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
   chmod +x get_helm.sh
   ./get_helm.sh

Step 4: Deploy OpenFaaS

1. Add the OpenFaaS Helm repository:

   helm repo add openfaas https://openfaas.github.io/faas-netes/

2. Create create namespace

   $ kubectl create namespace openfaas

3. Install OpenFaaS, specifying your release name (replace <your-release-name> with your desired name):

   helm upgrade <your-release-name> --install openfaas/openfaas \
   --namespace openfaas \
   --set functionNamespace=openfaas \
   --set basic_auth=true \
   --set image_pull_policy=IfNotPresent

Replace <your-release-name> with your desired release name.

4. Wait for OpenFaaS to deploy:

   kubectl -n openfaas get pods

5. Set up a port-forward to the OpenFaaS gateway if you haven't:

   kubectl port-forward -n openfaas svc/gateway 8080:8080 &

Step 5: Retrieve the Admin Password

To access the OpenFaaS admin console, retrieve the admin password: ```bash

echo $(kubectl -n openfaas get secret basic-auth -o jsonpath="{.data.basic-auth-password}" | base64 --decode)

Step 6: Access OpenFaaS UI

You can now access the OpenFaaS UI using the following URL, and log in with the admin username and the password you retrieved: ```bash

URL: http://127.0.0.1:8080/
Username: admin
Password: [The password you retrieved] 

Step 7: faas-cli credential login(for adding functions later)

faas-cli login --username admin --password <Password> --gateway http://127.0.0.1:8080

Setup Functions on OpenFaaS Now (Part II)

Step 1: Deploy the Function to OpenFaaS:

1. Navigate to our git repo for functions (Amelia) and clone the repo

   git clone https://gitlab.engr.illinois.edu/team-jaz-cs-598-ccc-final-project/CS598-faas-functions.git

2. Go to the dirctory inside

   faas-cli build -f function-1.yml
   faas-cli deploy -f function-1.yml

then we can see the function on openFaaS portal from http://127.0.0.1:8080/ui/

Step 2: Allow Images to Be Pulled In Pods

If you run into the issue trying and failing to pull image when looking at your deploy logs try this out. The reason is the Functions will deploy, but will not start due to imagePullPolicy set to Always. With this policy, Kubernetes will try to look for a private registry. You can either fix this by setting faas-cli to use a private registry or setting the policy for the deploy to IfNotPresent. For the second solution do this:

For example for function-2:

kubectl get deployment/function-2 -n openfaas -o yaml > function-2-deployment.yaml 
kubectl apply -f function-2-deployment.yaml

Edit the file now on your machine to change the imagePullPolicy to IfNotPresent. Now the you should see the function status change to ready.

If you need to deploy a newer version of your image after deploying function 2 try,

docker tag function-2:latest function-2:{whatever tag you would like}

Now change the image line in your function-2-deployment.yaml to function-2:{whatever tag you would like}. Run these two commands again.

kubectl get deployment/function-2 -n openfaas -o yaml > function-2-deployment.yaml 
kubectl apply -f function-2-deployment.yaml

kubectl get deployment queue-worker -n openfaas -o yaml > queue-worker-deployment.yaml
kubectl apply -f ueue-worker-deployment.yaml

Now your function status should be Ready. Repeat for any additional functions.

Additional Debugging Tools

Inspecting Kubernetes

kubectl get pods -n openfaas
kubectl describe pods/{pod name} -n openfaas

kubectl get deploy -n openfaas
kubectl describe deploy/{deploy name} -n openfaas

kubectl logs {pod name} -n openfaas
kubectl logs {deploy name} -n openfaas

kubectl delete deployment function-1 --namespace openfaas
kubectl delete service function-1 --namespace openfaas

faas-cli build -f function-1.yml --no-cache

Inspecting MiniKube Env

Sometimes images will not be in the minikube env if you have not configured your shell terminal window to use MiniKube's Docker Env. Make sure you do this for each new terminal window.

eval $(minikube docker-env)

To make sure your MiniKube Docker Env has the images

minikube ssh 
docker images

NATS local test

Pull the Latest NATS Docker Image , then Run the NATS Server Container:

docker pull nats
docker run -d --name nats-server -p 4222:4222 -p 8222:8222 nats -m 8222