Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.11 KB

local_environment.md

File metadata and controls

61 lines (40 loc) · 2.11 KB
Raw

Local Environment Guide

These docs provide step by step instructions for how to get the Quibbble controller up and running on a local K8s cluster running on your machine.

Pre-Requisites

Please install the following tools:

Create Local Cluster

There are a number of local cluster solutions out there; Minikube, Kind, and K3d to name a few. Quibbble currently runs on K3s in production and given that K3d is just a wrapper on top of K3s we recommend using K3d for local testing.

Install K3d

Please follow the installation instructions on k3d.io to install it onto your specific OS.

Create Cluster

This will start a single node cluster on your local machine and expose port 80 to allow you to interact with the cluster over http. Please make sure this quibbble-controller repo is your root directory before running the make command.

make create_cluster

Install NGINX

helm upgrade --install ingress-nginx ingress-nginx \
    --repo https://kubernetes.github.io/ingress-nginx \
    --namespace ingress-nginx --create-namespace

Create Admin Password

Create a k8s secret that holds your admin password.

kubectl create secret generic quibbble-controller \
    --namespace=quibbble \
    --from-literal=admin-password=<YOUR_PASSWORD_HERE>

Install Quibbble Controller

This will install the Quibbble Controller onto your cluster. You should not need to make any changes but take values.yaml file beforehand and change any values as desired.

helm upgrade --install quibbble-controller charts/quibbble-controller \
    --values charts/quibbble-controller/values.yaml \
    --namespace quibbble --create-namespace

Check Setup

You should now be able to curl and hit the Quibbble Controller.

curl http://127.0.0.1/health